Sm_PolicyApi_DeleteRealm()

Deletes the realm identified by pszRealOid.

Note: You cannot delete a realm while it is inked to rules.

Type

Realm function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_DeleteRealm (
   void*          pSessionHandle,
   const char*    pszRealmOid
);

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.
pszRealmOid	I	A null-terminated string containing the object identifier of an existing realm.

Returns

Sm_PolicyApi_Success. The realm was deleted successfully.
Sm_PolicyApi_Failure. The realm 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 a realm.
Sm_PolicyApi_InvalidOid. The realm OID was not found.