Sm_PolicyApi_RemovePolicyLinkFromPolicy()

Programming Guides › Programming Guide for C › Policy Management API Guidance › Function Declarations for the Policy Management API › Sm_PolicyApi_RemovePolicyLinkFromPolicy()

Sm_PolicyApi_RemovePolicyLinkFromPolicy()

By removing the policy link identified by pszPolicyLinkOid from the policy identified by pszPolicyOid, this function effectively removes the rule from the policy.

A policy link object binds a policy to a rule and, optionally, a response.

Note: In releases prior to SiteMinder v4.5, the functionality provided by Sm_PolicyApi_RemovePolicyLinkFromPolicy() was provided by Sm_PolicyApi_RemoveRuleFromPolicy().

Type

Policy function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_RemovePolicyLinkFromPolicy (
   void*          pSessionHandle,
   const char*    pszPolicyLinkOid,
   const char*    pszPolicyOid
);

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.
pszPolicyLinkOid	I	A null-terminated string containing the object identifier of an existing policy link under pszPolicyOid.
pszPolicyOid	I	A null-terminated string containing the object identifier of an existing policy.

Returns

Sm_PolicyApi_Success. The policy link was removed successfully.
Sm_PolicyApi_Failure. The policy link was not removed successfully.
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 remove a policy link.
Sm_PolicyApi_InvalidOid:
- The policy OID was not found.
- The policy link OID was not found.