Sm_PolicyApi_FlushUser()
Flushes a user from a User Cache.
casso10
Flushes a user from a User Cache.
Type
Utility function.
Syntax
int SM_EXTERN Sm_PolicyApi_FlushUser (void*pSessionHandle,const char*pszUserDirOid,const char*pszUserDN,char**pszErrMsg);
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. |
pszUserDN
| I | A null-terminated string containing the name of a user in an existing user directory who is to be flushed from the user cache. |
pszErrMsg
| O | Error message returned by the Policy Management API. You release the memory allocated for this variable by using a call to Sm_PolicyApi_FreeString(). |
Returns
- Sm_PolicyApi_Success. The flush operation was successful.
- Sm_PolicyApi_Failure. The flush operation was not successful or memory could not be allocated to the error message string.
- Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
- Sm_PolicyApi_NoSession. There is no valid administrator session. There is no valid administrator session.
- Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to flush a user.
- Sm_PolicyApi_InvalidOid. The user directory OID was not found.