Windows Dev Center

RasGetConnectStatus function

The RasGetConnectStatus function retrieves information on the current status of the specified remote access connection. An application can use this call to determine when an asynchronous RasDial call is complete.

Syntax


DWORD RasGetConnectStatus(
  _In_    HRASCONN        hrasconn,
  _Inout_ LPRASCONNSTATUS lprasconnstatus
);

Parameters

hrasconn [in]

Specifies the remote access connection for which to retrieve the status. This handle must have been obtained from RasDial or RasEnumConnections.

lprasconnstatus [in, out]

Pointer to the RASCONNSTATUS structure that, on output, receives the status information.

On input, set the dwSize member of the structure to sizeof(RASCONNSTATUS) in order to identify the version of the structure being passed.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is one of the following error codes or a value from Routing and Remote Access Error Codes or Winerror.h.

ValueMeaning
ERROR_NOT_ENOUGH_MEMORY

The function could not allocate sufficient memory to complete the operation.

 

Remarks

The return value for RasGetConnectStatus is not necessarily equal to the value of the dwError member of the RASCONNSTATUS structure returned by RasGetConnectStatus. The return value of RasGetConnectStatus indicates errors that occur during the RasGetConnectStatus function call, whereas the dwError member indicates errors that prevented the connection from being established.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Ras.h

Library

Rasapi32.lib

DLL

Rasapi32.dll

Unicode and ANSI names

RasGetConnectStatusW (Unicode) and RasGetConnectStatusA (ANSI)

See also

Remote Access Service (RAS) Overview
Remote Access Service Functions
RASCONNSTATUS
RasDial
RasEnumConnections

 

 

Community Additions

ADD
Show:
© 2015 Microsoft