RasReceiveBuffer

The custom-scripting DLL calls the RasReceiveBuffer function to inform RAS that it is ready to receive data from the server over the specified port.

typedef DWORD (APIENTRY *PFNRASRECEIVEBUFFER) (
  HANDLE    hPort,
  PBYTE     pBuffer,
  PDWORD    pdwSize,
  DWORD     dwTimeout,
  HANDLE    hEvent
);

Parameters

hPort

Handle to the port on which to receive the data. This handle should be the handle passed in by RAS as the first parameter of the RasCustomScriptExecute function.

pBuffer

Pointer to a buffer to receive the data from the port specified by the hPort parameter. Obtain this buffer using RasGetBuffer function.

pdwSize

Pointer to a DWORD variable that receives the size of the data returned in the buffer pointed to by the pBuffer parameter.

dwTimeout

Specifies a time-out period in milliseconds after which the custom-scripting DLL will no longer wait for the data.

hEvent

Handle to an event object that RAS will signal when the received data is available.

Return values

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value can be one of the following error codes.

Remarks

RasReceiveBuffer is an asynchronous function. RasReceiveBuffer returns immediately even if the data is not yet available. The custom-scripting DLL must wait on the event object specified by the hEvent parameter. When the data is available, RAS signals this event. The custom-scripting DLL should then call the RasRetrieveBuffer function to obtain the data. The custom-scripting DLL may pass the same buffer pointer in RasRetrieveBuffer that it passed in RasReceiveData.

RAS also signals the event object if, for some reason, the port is disconnected before the data is posted. In this case, RasRetrieveBuffer returns an error defined in Raserror.h, that indicates the cause of the failure.

The custom-scripting DLL calls RasReceiveBuffer through a function pointer. The function pointer is passed to the custom-scripting DLL as a parameter when RAS calls the DLL's implementation of RasCustomScriptExecute.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Rasdlg.h.

See Also

RAS Custom-Scripting, RasCustomScriptExecute, RasSendBuffer