Sm_PolicyApi_GetRule()

Gets the contents of the rule identified by pszRuleOid.
casso126
Gets the contents of the rule identified by
pszRuleOid
.
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_GetRule (
void*pSessionHandle,
const char*pszRuleOid,
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.
pszRuleOid
I
A null-terminated string containing the object identifier 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 rule OID was not found.