Sm_PolicyApi_GetPolicyLinks()

Returns a linked list of all of the policy links that are associated with the policy identified by pszPolicyOid.
sm1252sp1
Returns a linked list of all of the policy links that are associated with the policy identified by
pszPolicyOid
.
The linked list returned is referenced by the
ppstructPolicyLink
structure. Free the memory allocated to these structures by calling Sm_PolicyApi_FreeMemoryEx().
Type
Policy function, domain scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetPolicyLinks (
void*pSessionHandle,const char*pszPolicyOid,Sm_PolicyApi_PolicyLink_t**ppstructPolicyLink
);
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.
ppstructPolicyLink
O
The address of a policy link structure.
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. Memory is not allocated to Sm_PolicyApi_PolicyLink_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 list of policy links.
  • Sm_PolicyApi_InvalidOid. The policy OID was not found.