RasEnumConnections
The RasEnumConnections
function lists all active RAS connections. It returns each connection s handle
and phone-book entry name.
DWORD RasEnumConnections(
|
LPRASCONN lprasconn, |
// buffer to
receive connections data |
|
LPDWORD lpcb, |
// size in bytes of
buffer |
|
LPDWORD lpcConnections |
// number of
connections written to buffer |
|
); |
|
Parameters
lprasconn
Points to a
buffer that receives an array of RASCONN structures, one for each RAS connection. Before
calling the function, an application must set the dwSize member of the
first RASCONN structure in the buffer to sizeof(RASCONN) in order
to identify the version of the structure being passed.
lpcb
Points to a
variable that contains the size, in bytes, of the buffer specified by lprasconn.
On return, the function sets this variable to the number of bytes required to
enumerate the RAS connections.
lpcConnections
Points to a
variable that the function sets to the number of RASCONN structures
written to the buffer specified by lprasconn.
Return Values
If the
function succeeds, the return value is zero.
If the
function fails, the return value is a nonzero error value listed in the RAS
header file or one of ERROR_BUFFER_TOO_SMALL or ERROR_NOT_ENOUGH_MEMORY.
Remarks
If a
connection was made without specifying a phone-book entry name, the information
returned for that connection will give the connection phone number preceded by
. .
See Also