Функция обратного вызова PFNRASRETRIEVEBUFFER (ras.h)

Статья
03/15/2023

Библиотека DLL пользовательских сценариев вызывает функцию RasRetrieveBuffer для получения данных, полученных с сервера RAS через указанный порт. Библиотека DLL пользовательских сценариев должна вызывать RasRetrieveBuffer только после того, как RAS сообщит объекту события, переданному в вызове RasReceiveBuffer.

Тип PFNRASRETRIEVEBUFFER определяет указатель на эту функцию обратного вызова. RasRetrieveBuffer — это заполнитель для имени определяемой приложением функции.

Синтаксис

PFNRASRETRIEVEBUFFER Pfnrasretrievebuffer;

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

Параметры

hPort

Дескриптор до порта, на котором будут приниматься данные. Этот дескриптор должен быть дескриптором, переданным RAS в качестве первого параметра функции RasCustomScriptExecute .

pBuffer

Указатель на буфер для получения данных из порта, указанного параметром hPort . Получите этот буфер с помощью функции RasGetBuffer . Значение этого параметра может совпадать с указателем на буфер, переданный в функцию RasReceiveBuffer .

pdwSize

Указатель на переменную DWORD , которая получает размер данных, возвращаемых в буфере, на который указывает параметр pBuffer .

Возвращаемое значение

Если функция завершается успешно, возвращаемое значение будет ERROR_SUCCESS.

Если функция завершается сбоем, возвращаемое значение может быть одним из следующих кодов ошибок.

Значение	Значение
ERROR_BUFFER_INVALID	Недопустимый указатель на буфер, переданный в параметре pBuffer .
ERROR_INVALID_PORT_HANDLE	Дескриптор, указанный параметром hPort , недопустим.

RAS сообщает объекту события, если порт по какой-либо причине отключается перед отправкой данных. В этом случае RasRetrieveBuffer возвращает ошибку, определенную в Файле Raserror.h, которая указывает причину сбоя.

Функция RasRetrieveBuffer является синхронной. При возврате буфер, на который указывает параметр pBuffer , содержит данные, полученные через указанный порт. Библиотека DLL пользовательского скрипта должна вызывать RasRetrieveBuffer только после того, как RAS-файл сообщит объекту события о том, что библиотека DLL передала в вызове RasReceiveBuffer.

Библиотека DLL пользовательских сценариев вызывает RasRetrieveBuffer через указатель функции. Указатель функции передается в библиотеку DLL пользовательского скрипта в качестве параметра, когда RAS вызывает реализацию Библиотеки DLL RasCustomScriptExecute.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	ras.h

См. также раздел

Пользовательские скрипты RAS

RasCustomScriptExecute

RasReceiveBuffer

RasSendBuffer

Поделиться через