Retrieve the user name for the client connection that is associated with a C or C++ component instance.
JagStatus JAG_PUBLIC JagGetUserName( SQLPOINTER userName, SQLINTEGER userNameLen, SQLINTEGER *returnLen)
The address of a character array to receive the user name. The user name can have 0 length if no user name was supplied. In this case, only a null-terminator will be written to *userName. (In practice, a user name is required to connect to the server unless user authentication is disabled.)
The length, in bytes, of the userName array. The length must include space for a null-terminator.
NULL or the address of a SQLINTEGER variable.
returnLen is an optional output parameter that receives the length in bytes of the userName value. The user name is null-terminated and the length includes the null-terminator.
Return value |
To indicate |
|---|---|
JAG_SUCCEED |
Success. |
JAG_FAIL |
Failure. |
JagGetUserName fails for the following reasons:
userName was NULL.
The buffer length is insufficient.
The routine was called in code that was not executing in the context of a component method call.
Check the server’s log file for more information when JagGetUserName fails.
