| |
| INT GetClientAddress( |
| |
UINT nClientId, |
|
| |
LPTSTR lpszAddress, |
|
| |
INT nMaxLength |
|
| ); |
| INT GetClientAddress( |
| |
UINT nClientId, |
|
| |
CString& strAddress |
|
| ); |
Return the IP address of the specified client session.
Parameters
- nClientId
- An unsigned integer which uniquely identifies the client
session.
- lpszAddress
- A pointer to a string buffer that will contain the client IP
address, terminated with a null character. To accommodate both IPv4
and IPv6 addresses, this buffer should be at least 46 characters in
length. This parameter cannot be NULL. An alternate version of this
method accepts a CString object if it is available.
- nMaxLength
- An integer value that specifies the maximum number of characters
can be copied into the string buffer, including the terminating null
character. This value must be greater than zero. If the buffer size
is too small, the method will fail.
Return Value
If the method succeeds, the return value is the number of
characters copied into the string buffer, not including the
terminating null character. If the client ID is invalid, or the buffer
is not large enough to store the complete address, the method will
return a value of zero.
Remarks
The format and length of IPv4 and IPv6 address strings are very
different. An IPv4 address string looks like "192.168.0.20", while an
IPv6 address string can look something like
"fd7c:2f6a:4f4f:ba34::a32". If your application checks for the format
of these address strings, it needs to be aware of the differences. You
also need to make sure that you're providing enough space to display
or store an address to avoid buffer overruns.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csftsv10.lib
Unicode: Implemented as Unicode and ANSI versions.
See Also
GetClientDirectory,
GetClientUserName
|
|