Sm_PolicyApi_AddDomain()

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

Sm_PolicyApi_AddDomain()

Creates a new SiteMinder domain. Attributes of the domain are contained in the pstructDomain structure.

If the domain exists and the bUpdate flag is true, the item is updated.

Type

Domain function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_AddDomain (
   void*                    pSessionHandle,
   Sm_PolicyApi_Domain_t*   pstructDomain,
   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.
pstructDomain	I	A pointer to a completely filled-in domain structure.
bUpdate	I	A flag to indicate that if an existing object is found, it should be updated.

Returns

Sm_PolicyApi_Success. The domain was created successfully.
Sm_PolicyApi_Failure. The 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 a domain.
Sm_PolicyApi_InvalidOid. The domain OID was not found during an update.