Sm_PolicyApi_GetUserPasswordState()
Returns Sm_Api_UserPasswordState_t. The memory for the Sm_Api_UserPasswordState_t object should be allocated by the calling function.
casso10
Returns Sm_Api_UserPasswordState_t. The memory for the Sm_Api_UserPasswordState_t object should be allocated by the calling function.
Type
Password state function.
Syntax
int SM_EXTERN Sm_PolicyApi_GetUserPasswordState (void*pSessionHandle,const char*pszUserDirOid,const char*pszUserDN,Sm_PolicyApi_UserPasswordState_t*pPasswordState);
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 | Unique object identifier that corresponds to a particular User Directory. |
pszUserDN
| I | Specifies the DN of the user within the user directory. |
pPasswordState
| O | The user password state object. |
Returns
- Sm_PolicyApi_Success. The get operation was successful.
- Sm_PolicyApi_Failure. Generalized failure.
- Sm_PolicyApi_InvalidHandle. The session pointer is not valid.
- Sm_PolicyApi_BadArgument. The input password state pointer is NULL.
- Sm_PolicyApi_NoSession. The API user is not properly logged in.
- Sm_PolicyApi_InvalidOid. The unique ID does not correspond to User Directory object.
- Sm_PolicyApi_UserDirNotFound. Failed to retrieve User Directory object from policy store.
- Sm_PolicyApi_ErrorUserDir. Invalid User Directory object or wrong user DN.
- Sm_PolicyApi_NoPrivilege. The caller does not have the proper privileges.