Sm_PolicyApi_DeleteAffiliateDomain()

Deletes an existing affiliate domain.
casso127
Deletes an existing affiliate domain.
Type
Federation function
Syntax
int SM_EXTERN Sm_PolicyApi_DeleteAffiliateDomain (
void*pSessionHandle,
const char*pszAffiliateDomainOid
);
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.
Returns
  • Sm_PolicyApi_Success. The affiliate domain was deleted successfully.
  • Sm_PolicyApi_Failure. The affiliate domain was not deleted successfully.
  • Sm_PolicyApi_NoSession. There is no valid administrator session.
  • Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
  • Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to delete an affiliate domain.
  • Sm_PolicyApi_InvalidOid. An affiliate with the specified OID was not found during an update.