Function name: WNetGetConnection

Defined in : mpr

Requirements : Windows NT 3.1 or later; Windows 95 or later

Declaration:

Private Declare Function WNetGetConnection Lib "mpr.dll" Alias "WNetGetConnectionA" (ByVal lpszLocalName As String, ByVal lpszRemoteName As String, cbRemoteName As Long) As Long

Parameters:

* lpLocalName [in] Pointer to a constant null-terminated string that specifies the name of the local device to get the network name for. * lpRemoteName [out] Pointer to a buffer that receives the null-terminated remote name used to make the connection. * lpnLength [in/out] Pointer 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 large enough, this parameter returns the required buffer size.

Returns:

If the function succeeds, the return value is NO_ERROR. If the function fails, the return value is a system error code, such as one of the following values. ERROR_BAD_DEVICE The string pointed to by the lpLocalName parameter is invalid. ERROR_NOT_CONNECTED The device specified by lpLocalName is not a redirected device. For more information, see the following Remarks section. 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. For more information, see the following Remarks section. ERROR_NO_NETWORK The network is unavailable. ERROR_EXTENDED_ERROR A network-specific error occurred. To obtain a description of the error, call the WNetGetLastError function. ERROR_NO_NET_OR_BAD_PATH None of the providers recognize the local name as having a connection. However, the network is not available for at least one provider to whom the connection may belong.

Related functions:

Examples:

Sorry, this function has no examples yet.