Função de retorno de chamada PFNRASRETRIEVEBUFFER (ras.h)

A DLL de script personalizado chama a função RasRetrieveBuffer para obter dados recebidos do servidor RAS pela porta especificada. A DLL de script personalizado deve chamar RasRetrieveBuffer somente depois que RAS tiver sinalizado o objeto de evento passado na chamada para RasReceiveBuffer.

O tipo PFNRASRETRIEVEBUFFER define um ponteiro para essa função de retorno de chamada. RasRetrieveBuffer é um espaço reservado para o nome da função definida pelo aplicativo.

Sintaxe

PFNRASRETRIEVEBUFFER Pfnrasretrievebuffer;

DWORD Pfnrasretrievebuffer(
  HANDLE hPort,
  PBYTE pBuffer,
  PDWORD pdwSize
)
{...}

Parâmetros

hPort

Manipule para a porta na qual receber os dados. Esse identificador deve ser o identificador passado pelo RAS como o primeiro parâmetro da função RasCustomScriptExecute .

pBuffer

Ponteiro para um buffer para receber os dados da porta especificada pelo parâmetro hPort . Obtenha esse buffer usando a função RasGetBuffer . O valor desse parâmetro pode ser o mesmo que o ponteiro para o buffer passado para a função RasReceiveBuffer .

pdwSize

Ponteiro para uma variável DWORD que recebe o tamanho dos dados retornados no buffer apontado pelo parâmetro pBuffer .

Retornar valor

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado poderá ser um dos seguintes códigos de erro.

Valor	Significado
ERROR_BUFFER_INVALID	O ponteiro para o buffer passado no parâmetro pBuffer é inválido.
ERROR_INVALID_PORT_HANDLE	O identificador especificado pelo parâmetro hPort é inválido.

 

RAS sinalizará o objeto de evento se a porta for desconectada por algum motivo antes que os dados sejam postados. Nesse caso, RasRetrieveBuffer retorna um erro definido em Raserror.h, que indica a causa da falha.

Comentários

A função RasRetrieveBuffer é síncrona. Quando retorna, o buffer apontado pelo parâmetro pBuffer contém os dados recebidos pela porta especificada. A DLL de script personalizado deve chamar RasRetrieveBuffer somente depois que RAS tiver sinalizado o objeto de evento que a DLL passou na chamada para RasReceiveBuffer.

A DLL de script personalizado chama RasRetrieveBuffer por meio de um ponteiro de função. O ponteiro de função é passado para a DLL de script personalizado como um parâmetro quando RAS chama a implementação da DLL de RasCustomScriptExecute.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ras.h

Confira também

RAS Custom-Scripting

RasCustomScriptExecute

RasReceiveBuffer

RasSendBuffer