|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| Yes
| Win32s
| Yes
| Import Library
| mpr.lib
| Header File
| winnetwk.h
| Unicode
| WinNT
| Platform Notes
| None
|
|
|
WNetGetConnection
The WNetGetConnection function retrieves the name of the network resource associated with a local
device.
DWORD WNetGetConnection(
LPCTSTR lpLocalName,
| // pointer to local name
| LPTSTR lpRemoteName,
| // pointer to buffer for remote name
| LPDWORD lpnLength
| // pointer to buffer size, in characters
| );
|
|
Parameters
lpLocalName
Points to a null-terminated string that specifies the name of the local device
to get the network name for.
lpRemoteName
Points to a buffer that receives the null-terminated remote name used to make
the connection.
lpnLength
Points to a variable that specifies the size, in characters, of the buffer
pointed to by the lpRemoteName parameter. If the function fails because the buffer is not big enough, this
parameter returns the required buffer size.
Return Values
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is an error code. To get extended
error information, call GetLastError. GetLastError may return one of the following error codes:
Value
| Meaning
| ERROR_BAD_DEVICE
| The string pointed to by the lpLocalName parameter is invalid.
| ERROR_NOT_CONNECTED
| The device specified by lpLocalName is not redirected.
| ERROR_MORE_DATA
| The buffer is too small. The lpnLength parameter points to a variable that contains the required buffer size. More
entries are available with subsequent calls.
| ERROR_CONNECTION_UNAVAIL
| The device is not currently connected, but it is a persistent connection.
| ERROR_NO_NETWORK
| No network is present.
| ERROR_EXTENDED_ERROR
| A network-specific error occurred. To get a description of the error, use the WNetGetLastError function.
| ERROR_NO_NET_OR_BAD_PATH
| None of the providers recognized this local name as having a connection.
However, the network is not available for at least one provider to whom the
connection may belong.
|
The WNetGetConnection function returns error codes for compatibility with Windows version 3.1. For
compatibility with the Win32 API, the function also sets the error code value
returned by GetLastError.
See Also
WNetAddConnection2, WNetAddConnection3, WNetGetLastError, WNetGetUser
Related Links
Software for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET
TMS Scripter Studio Pro components for Delphi/C++Builder
More Online Helps
Win32 Multimedia Programmer's Reference (mmedia.hlp)
OLE Programmer's Reference (ole.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (tapi.hlp)
Unix Manual Pages
|
