Chapter 5 C Routines Reference

JagGetPassword

Description

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

Syntax

JagStatus JAG_PUBLIC JagGetPassword(
          SQLPOINTER  password, 
          SQLINTEGER  passwordLen,
          SQLINTEGER *returnLen)

Parameters

password

The address of a character array to receive the client password. If the connection has a NULL password, JagGetPassword writes a null-terminator to the password buffer.

passwordLen

The length, in bytes, of the password 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 password value. The host name is null-terminated and the length includes the null-terminator.

Return Value

JagGetPassword fails for the following reasons:

• password 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 JagGetPassword fails.

See Also

JagGetHostName, JagGetUserName

Copyright (C) 2004. Sybase Inc. All rights reserved.