Chapter 5 C Routines Reference

JagGetUserName

Description

Retrieve the user name for the client connection that is associated with a C or C++ component instance.

Syntax

JagStatus JAG_PUBLIC JagGetUserName(
          SQLPOINTER userName, 
          SQLINTEGER userNameLen,
          SQLINTEGER *returnLen)

Parameters

userName 

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.)

userNameLen 

The length, in bytes, of the userName array. The length must include space for a null-terminator.

returnLen 

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 Values

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.

See Also

JagGetHostName, JagGetPassword

Copyright © 2001 Sybase, Inc. All rights reserved.