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

Sm_PolicyApi_AddPolicyLink()

Creates a new SiteMinder policy link for the policy identified by pszPolicyOid.

A policy link object binds a policy to a rule and, optionally, a response. The attributes of the new policy link are contained in the pstructPolicyLink structure.

If the policy link exists and the bUpdate flag is true, the item is updated.

Type

Policy function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_AddPolicyLink (
   void*                         pSessionHandle,
   const                         pszPolicyOid, 
   Sm_PolicyApi_PolicyLink_t*    pstructPolicyLink
);

Returns

• Sm_PolicyApi_Success. The policy link was created successfully.
• Sm_PolicyApi_Failure:
  • The domain of a rule OID is not the same as the domain of the policy OID.
  • The domain of a response OID is not the same as the domain of the policy OID.
• 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 create a policy link.
• Sm_PolicyApi_InvalidOid:
  • The policy OID was not found.
  • The rule or rule group OID was not found.
  • The response or response group OID was not found.