RasGetProjectionInfo function

The RasGetProjectionInfo function obtains information about a remote access projection operation for a specified remote access component protocol.

Syntax


DWORD RasGetProjectionInfo(
  _In_    HRASCONN      hrasconn,
  _In_    RASPROJECTION rasprojection,
  _Out_   LPVOID        lpprojection,
  _Inout_ LPDWORD       lpcb
);

Parameters

hrasconn [in]

Handle to the remote access connection of interest. An application obtains a RAS connection handle from the RasDial or RasEnumConnections function.

rasprojection [in]

Specifies the RASPROJECTION enumerated type value that identifies the protocol of interest.

lpprojection [out]

Pointer to a buffer that receives the information specified by the rasprojection parameter. The information is in a structure appropriate to the rasprojection value.

rasprojection valueMeaning
RASP_Amb

RASAMB

Note  Supported on Windows 2000 or earlier.
 
RASP_PppCcp

RASPPPCCP

Note  Supported on Windows 2000 or later.
 
RASP_PppIp

RASPPPIP

RASP_PppIpv6

RASPPPIPV6

Note  Supported on Windows Vista or later.
 
RASP_PppIpx

RASPPPIPX

Note  Not supported on 64-bit Microsoft Windows.
 
RASP_PppLcp

RASPPPLCP

Note  Supported on Windows 2000 or later.
 
RASP_PppNbf

RASPPPNBF

Note  Supported on Windows 2000 or earlier.
 
RASP_Slip

RASPSLIP

Note  Supported on Windows Server 2003 or earlier.
 

 

lpcb [in, out]

Pointer to a variable that, on input, specifies the size, in bytes, of the buffer pointed to by lpprojection.

On output, this variable receives the size, in bytes, of the lpprojection buffer.

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_BUFFER_TOO_SMALL

The buffer pointed to by lpprojection is not large enough to contain the requested information.

ERROR_INVALID_HANDLE

The hrasconn parameter is not a valid handle.

ERROR_INVALID_PARAMETER

One of the parameters is invalid.

ERROR_INVALID_SIZE

The dwSize member of the structure pointed to by lpprojection 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. This is a RAS error code.

 

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 RasDial RASCS_Projected state on the remote access connection. If RasGetProjectionInfo is called prior to the RASCS_Projected state, it returns ERROR_PROJECTION_NOT_COMPLETE.

The NetBEUI protocol and authentication message blocks (AMB) are only supported on Windows 2000 and earlier versions of Windows.

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

RasGetProjectionInfoW (Unicode) and RasGetProjectionInfoA (ANSI)

See also

Remote Access Service (RAS) Overview
Remote Access Service Functions
RASAMB
RasDial
RasEnumConnections
RASPPPCCP
RASPPPIP
RASPPPIPV6
RASPPPIPX
RASPPPLCP
RASPPPNBF
RASPROJECTION
RASPSLIP

 

 

Community Additions

ADD
Show: