Sm_PolicyApi_GetUserDir()

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

Sm_PolicyApi_GetUserDir()

Gets the contents of the user directory identified by pszUserDirOid.

The results of this function are returned in a structure referenced by ppstructUserDir. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().

Type

User directory function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetUserDir (
   void*                      pSessionHandle,
   const char*                pszUserDirOid,
   Sm_PolicyApi_UserDir_t**   ppstructUserDir
);

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.
ppstructUserDir	O	Address of a pointer to a user directory structure.

Returns

Sm_PolicyApi_Success. The get operation was successful.
Sm_PolicyApi_Failure. Memory could not be allocated for Sm_PolicyApi_UserDir_t.
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 get a user directory.
Sm_PolicyApi_InvalidOid. The user directory OID was not found.