Sm_PolicyApi_GetRuleByName()

Gets the contents of the rule identified by pszRuleName.
casso10
Gets the contents of the rule identified by
pszRuleName
.
The results are returned in a structure referenced by
ppstructRule
. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().
Type
Rule function, domain scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetRuleByName (
void*pSessionHandle,
const char*szRealmOid,
const char*pszRuleName,
Sm_PolicyApi_Rule_t**ppstructRule
);
Parameter
I/O
Description
pSessionHandle
I
A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
szRealmOid
I
A null-terminated string containing the object identifier of an existing Realm.
pszRuleName
I
A null-terminated string containing the name of an existing rule.
ppstructRule
O
The address of a pointer to a Sm_PolicyApi_Rule_t structure.
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_Rule_t.
  • Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
  • Sm_PolicyApi_NoSession. There is no valid administrator session.
  • Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get a rule.
  • Sm_PolicyApi_InvalidOid. The Realm OID was not found.
  • Sm_PolicyApi_NotFound. The rule name was not found.