Sm_PolicyApi_AddAffiliateDomain()

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

Sm_PolicyApi_AddAffiliateDomain()

Creates a new or updates an existing affiliate domain. Sets bIsAffiliate to TRUE.

Type

Federation Security Services function.

Syntax

int SM_EXTERN Sm_PolicyApi_AddAffiliateDomain (
   void*                           pSessionHandle,
   Sm_PolicyApi_AffiliateDomain_t  *pstructAffiliateDomain,
   const bool                      bUpdate
);

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 Domain	I	A pointer to a completely filled-in affiliate domain structure.
bUpdate	I	A boolean flag to indicate that if an existing object is found, it should be updated.

Returns

Sm_PolicyApi_Success. The affiliate domain was created successfully.
Sm_PolicyApi_Failure. The affiliate domain was not created 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 create an affiliate domain.
Sm_PolicyApi_DomainNotFound. The affiliate domain OID was not found during an update.
Sm_PolicyApi_DomainNotAffiliate. The domain is not an affiliate domain.

Email CA about this topic