Sm_PolicyApi_GetAffiliateDomainObjects()

Gets affiliate domain objects.
casso127
Gets affiliate domain objects.
Type
Federation function
Syntax
int SM_EXTERN Sm_PolicyApi_GetAffiliateDomainObjects (
void*pSessionHandle,
const char*pszAffiliateDomainOid,
const Sm_PolicyApi_Objects_tnObjectId,
Sm_PolicyApi_Oid_t**ppstructObject
);
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.
nObjectId
I
The type of domain object to retrieve. Valid types are for affiliate, admin, and user directory objects only.
ppstructObject
O
The address of a pointer to a Sm_PolicyApi_Oid_t structure
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. The get operation was not successful.
  • 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 affiliate domain objects.
  • Sm_PolicyApi_InvalidOID. The affiliate domain OID was not found.