Sm_PolicyApi_GetPolicy()

Gets the contents of the policy identified by pszPolicyOid.
casso127
Gets the contents of the policy identified by
pszPolicyOid
.
The results of this function are returned in a structure referenced by
ppstructPolicy
. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().
Type
Policy function, domain scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetPolicy (
void*pSessionHandle,const char*pszPolicyOid,Sm_PolicyApi_Policy_t**ppstructPolicy
);
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.
pszPolicyOid
I
A null-terminated string containing the object identifier of an existing policy.
ppstructPolicy
O
The address of a pointer to a policy structure.
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_Policy_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 policy.
  • Sm_PolicyApi_InvalidOid. The policy OID was not found.