RasGetProjectionInfoEx function (ras.h)

Article
10/13/2021

The RasGetProjectionInfoEx function obtains information about Point-to-Point Protocol (PPP) or Internet Key Exchange version 2 (IKEv2) remote access projection operations for all RAS connections on the local client.

Syntax

DWORD RasGetProjectionInfoEx(
  [in]      HRASCONN             hrasconn,
  [in, out] PRAS_PROJECTION_INFO pRasProjection,
  [in, out] LPDWORD              lpdwSize
);

Parameters

[in] hrasconn

A handle to the RAS connection for which the tunnel endpoints are to be changed. This can be a handle returned by the RasDial or RasEnumConnections function.

[in, out] pRasProjection

A pointer to a RAS_PROJECTION_INFO structure that receives the projection information for the RAS connections.

[in, out] lpdwSize

A pointer, in input, that specifies the size, in bytes, of the buffer pointed to by pRasProjection. On output, this variable receives the size, in bytes, of the buffer needed to store the number of RAS_PROJECTION_INFO structures pointed to by pRasProjection.

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.

Value	Meaning
ERROR_BUFFER_TOO_SMALL	The buffer pointed to by pRasProjection is not large enough to contain the requested information.
ERROR_INVALID_HANDLE	The hrasconn parameter is not a valid handle.
ERROR_INVALID_PARAMETER	The function was called with an invalid parameter.
ERROR_INVALID_SIZE	The dwSize member of the structure pointed to by pRasProjection specifies an invalid size.
ERROR_PROTOCOL_NOT_CONFIGURED	The control protocol for which information was requested neither succeeded nor failed, because the connection's phone-book entry did not require that an attempt to negotiate the protocol be made.

Remarks

Remote access projection is the process whereby a remote access server and a remote client negotiate network protocol-specific information. A remote access server uses this network protocol-specific information to represent a remote client on the network.

Remote access projection information is not available until the operating system has executed the RASCS_Projected state on the remote access connection. If RasGetProjectionInfoEx is called prior to the RASCS_Projected state, it returns ERROR_PROJECTION_NOT_COMPLETE.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	ras.h
Library	Rasapi32.lib
DLL	Rasapi32.dll