Sm_PolicyApi_GetUserDirCapabilities()

Retrieves the user directory capabilities.
sm1252sp1
Retrieves the user directory capabilities.
The user directory capabilities are enumerated in Sm_DirectoryCapability_t in SmApi.h.
Type
User directory function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetUserDirCapabilities (
void*pSessionHandle,
const char*pszUserDirOid,
unsigned long*pCapabilities
);
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 the user directory where the lookup has to be performed.
pCapabilities
O
The address of a pointer to an unsigned long that will hold information about directory capability. Directory capabilities are enumerated in Sm_DirectoryCapability_t, which is defined in the header file SmApi.h. See Figure12 on page 103.
Returns
  • Sm_PolicyApi_Success. The retrieve was successful.
  • 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 retrieve user directory capability.
  • Sm_PolicyApi_InvalidOid. The user directory OID was not found.