Sm_PolicyApi_RemoveAttributeFromAffiliate()

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

Sm_PolicyApi_RemoveAttributeFromAffiliate()

Removes an attribute from an affiliate.

Type

Federation Security Services function.

Syntax

int SM_EXTERN Sm_PolicyApi_RemoveAttributeFromAffiliate (
   void*                               pSessionHandle,
   const Sm_PolicyApi_AffiliateAttr_t* pstructAffiliateAttr,
   const char*                         pszAffiliateOid
);

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.
pstructAffiliate Attr	I	A pointer to an affiliate attribute structure.
pszAffiliateOid	I	A null-terminated string containing the object identifier of an existing affiliate.

Returns

Sm_PolicyApi_Success. The affiliate attribute was removed successfully.
Sm_PolicyApi_Failure. The affiliate attribute 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 an affiliate attribute.
Sm_PolicyApi_InvalidOID. The affiliate OID was not found.

Email CA about this topic