Sm_PolicyApi_ValidateDirectoryEntry()

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

Sm_PolicyApi_ValidateDirectoryEntry()

Validates a user specification in a user directory.

Type

User directory function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_ValidateDirectoryEntry (
   void*                  pSessionHandle,
   const char*            pszUserDirOid,
   const char*            pszPath,
   Sm_PolicyApi_User_t**  ppUserEntry
);

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.
pszPath	I	A null-terminated string containing the path of a user.
ppUserEntry	O	The address of a pointer to a user structure.

Returns

Sm_PolicyApi_Success. The validation was successful.
Sm_PolicyApi_Failure:
- The policy resolution of the user path in pszPath is not of type Sm_PolicyResolution_User.
- There is no connection to the user directory or the user directory provider has not been loaded.
- Memory could not be allocated to Sm_PolicyApi_User_t.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_InvalidOid. The user directory OID was not found.