Sm_PolicyApi_DeleteUserDir()

Deletes the user directory identified by pszUserDirOid.

Type

User directory function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_DeleteUserDir (
   void*          pSessionHandle,
   const char*    pszUserDirOid
);

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

Returns

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