Sm_PolicyApi_RemoveUserDirFromDomain()

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

Sm_PolicyApi_RemoveUserDirFromDomain()

Disassociates the user directory identified by pszUserDirOid from the domain identified by pszDomainOid.

Type

User directory function, global scope.

Syntax

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

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

Returns

Sm_PolicyApi_Success. The remove operation was successful.
Sm_PolicyApi_NotFound. The domain does not have any user directories.
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 remove a user directory from a domain.
Sm_PolicyApi_InvalidOid. A user directory or domain OID was not found.

Email CA about this topic