RasGetSubEntryHandle
[New
- Windows NT]
The RasGetSubEntryHandle
function retrieves a connection handle for a specified subentry of a multilink
connection.
DWORD RasGetSubEntryHandle(
|
HRASCONN hrasconn, |
|
|
DWORD dwSubEntry, |
|
|
LPHRASCONN lphrasconn |
|
|
); |
|
Parameters
hrasconn
Specifies an HRASCONN
connection handle returned by the RasDial function for a multilink
phone-book entry.
dwSubEntry
Specifies a
valid subentry index for the phone-book entry.
lphrasconn
Pointer to an
HRASCONN variable that receives a connection handle that represents the
subentry connection.
Return Values
If the
function succeeds, the return value is zero.
If the
function fails, the return value can be one of the following error codes.
|
Value |
Meaning |
|
ERROR_INVALID_HANDLE |
The hrasconn
connection handle does not represent a connected phone-book entry. |
|
ERROR_PORT_NOT_OPEN |
The hrasconn
and dwSubEntry parameters are valid, but the specified subentry is not
connected. |
|
ERROR_NO_MORE_ITEMS |
The value
specified by dwSubEntry exceeds the maximum number of subentries for
the phone-book entry. |
Remarks
The
connection handle specified in the hrasconn parameter refers to the
entire multilink connection, but the connection handle returned in the *lphrasconn
parameter refers only to the subentry connection. You can use the subentry
connection handle in any function that accepts an hrasconn parameter,
including the RasHangUp, RasGetConnectStatus, and RasGetProjectionInfo
functions. The projection information returned by RasGetProjectionInfo
for a multilink entry is the same for the each of the subentry connection
handles as it is for the main connection handle.
See Also