Sm_PolicyApi_GetAllAffiliates()

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

Sm_PolicyApi_GetAllAffiliates()

Gets all affiliates in the specified affiliate domain.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_GetAllAffiliates (
   void*                        pSessionHandle,
   const char*                  pszAffiliateDomainOid,
   Sm_PolicyApi_Affiliate_t**   ppstructAffiliates
);

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

Returns

Sm_PolicyApi_Success. The affiliates were retrieved successfully.
Sm_PolicyApi_Failure. The affiliates were 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 affiliates.
Sm_PolicyApi_InvalidOID. The affiliate domain OID was not found.