Sm_PolicyApi_GetAllAffiliateAttributes()

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

Sm_PolicyApi_GetAllAffiliateAttributes()

Gets all the attributes for an affiliate.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_GetAllAffiliateAttributes (
   void*                           pSessionHandle,
   const char*                     pszAffiliateOid,
   Sm_PolicyApi_AffiliateAttr_t**  ppstructAffiliateAttr
);

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.
pszAffiliateOid	I	A null-terminated string containing the object identifier of an existing affiliate.
ppstruct AffiliateAttr	O	The address of a pointer to an affiliate attribute structure.

Returns

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