Retrieve the client host name for the client connection that is associated with a C or C++ component instance.
JagStatus JAG_PUBLIC JagGetHostName( SQLPOINTER hostName, SQLINTEGER hostNameLen, SQLINTEGER *returnLen)
The address of a character array to receive the client host name or, if the client software did not supply a host name, a zero-length string.
The length, in bytes, of the hostName 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 hostName value. The host name is null-terminated and the length includes the null-terminator.
Return value |
To indicate |
|---|---|
JAG_SUCCEED |
Success |
JAG_FAIL |
Failure |
JagGetHostName fails for the following reasons:
hostName 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 JagGetHostName fails.
