Sm_PolicyApi_GetAffiliateDomainByName()

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

Sm_PolicyApi_GetAffiliateDomainByName()

Gets an affiliate domain.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_GetAffiliateDomainByName (
   void*                            pSessionHandle,
   const char*                      pszAffiliateDomainName,
   Sm_PolicyApi_AffiliateDomain_t** ppstructAffiliateDomain
);

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 DomainName	I	A null-terminated string containing the name of an existing affiliate domain.
ppstruct AffiliateDomain	O	The address of a pointer to an affiliate domain structure.

Returns

Sm_PolicyApi_Success. The affiliate domain was retrieved successfully.
Sm_PolicyApi_Failure. The affiliate domain 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 get an affiliate domain.
Sm_PolicyApi_NotFound. The affiliate domain name was not found.
Sm_PolicyApi_DomainNotAffiliate. The domain is not an affiliate domain.