In file ../../include/war170api.h:

WARAPI_RESULT Warapi_LookupUser(WAR_OUT WARAPI_SESSION_HANDLE SessionHandle, const WAR_OUT WARAPI_CCSTR_T Name, const WAR_OUT WARAPI_SEARCH_MASK SearchMask, WAR_IN WARAPI_USER_HANDLE *UserHandle, WAR_IN int *ErrorValue)

Find an existing node in the user database

Documentation

Find an existing node in the user database.

Note: The '*' character should not be used in the name, as this is used to search for patterns in some versions of the server. The use of pattern-matching characters are undefined, and may lead to unexpected and unpredictible results.

Returns:
WARAPI_CALL_OK if the function succeeded.
Parameters:
SessionHandle - Previously initialized session handle
Name - Path to the node, like "/system/user/johndoe"
SearchMask - Search parameters. See the WARAPI_SEARCH_MASK_* macros. The macros can be ored together.
UserHandle - Pointer to a variable where an initialized user handle will be returned if the function succeeds. This handle must be released with
Warapi_ReleaseUserHandle.
ErrorValue - A error value to indicate why the operation failed. This value will be WARAPI_ERR_OK if the function succeeded.
See Also:
Warapi_ReleaseUserHandle Warapi_OpenSession

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.