Freigeben über


PFNRASRETRIEVEBUFFER-Rückruffunktion (ras.h)

Die DLL für benutzerdefinierte Skripterstellung ruft die RasRetrieveBuffer-Funktion auf, um Daten abzurufen, die vom RAS-Server über den angegebenen Port empfangen werden. Die DLL für benutzerdefinierte Skripterstellung sollte RasRetrieveBuffer erst aufrufen, nachdem RAS signalisiert hat, dass das Ereignisobjekt im Aufruf von RasReceiveBuffer übergeben wurde.

Der PFNRASRETRIEVEBUFFER-Typ definiert einen Zeiger auf diese Rückruffunktion. RasRetrieveBuffer ist ein Platzhalter für den anwendungsdefinierte Funktionsnamen.

Syntax

PFNRASRETRIEVEBUFFER Pfnrasretrievebuffer;

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

Parameter

hPort

Behandeln Sie den Port, an dem die Daten empfangen werden sollen. Bei diesem Handle sollte es sich um das Handle handeln, das von RAS als erster Parameter der RasCustomScriptExecute-Funktion übergeben wird.

pBuffer

Zeiger auf einen Puffer, um die Daten von dem durch den hPort-Parameter angegebenen Port zu empfangen. Rufen Sie diesen Puffer mithilfe der RasGetBuffer-Funktion ab. Der Wert dieses Parameters kann mit dem Zeiger auf den Puffer identisch sein, der an die RasReceiveBuffer-Funktion übergeben wird.

pdwSize

Zeiger auf eine DWORD-Variable , die die Größe der im Puffer zurückgegebenen Daten empfängt, auf die der pBuffer-Parameter verweist.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert ERROR_SUCCESS.

Wenn die Funktion fehlschlägt, kann der Rückgabewert einer der folgenden Fehlercodes sein.

Wert Bedeutung
ERROR_BUFFER_INVALID
Der Zeiger auf den Puffer, der im pBuffer-Parameter übergeben wird, ist ungültig.
ERROR_INVALID_PORT_HANDLE
Das vom hPort-Parameter angegebene Handle ist ungültig.
 

RAS signalisiert das Ereignisobjekt, wenn der Port aus irgendeinem Grund getrennt wird, bevor die Daten veröffentlicht werden. In diesem Fall gibt RasRetrieveBuffer einen in Raserror.h definierten Fehler zurück, der die Ursache des Fehlers angibt.

Hinweise

Die RasRetrieveBuffer-Funktion ist synchron. Bei der Rückgabe enthält der Puffer, auf den der pBuffer-Parameter verweist, die Daten, die über den angegebenen Port empfangen werden. Die DLL für benutzerdefinierte Skripterstellung sollte RasRetrieveBuffer erst aufrufen, nachdem RAS das Ereignisobjekt signalisiert hat, das die DLL im Aufruf von RasReceiveBuffer übergeben hat.

Die DLL für benutzerdefinierte Skripterstellung ruft RasRetrieveBuffer über einen Funktionszeiger auf. Der Funktionszeiger wird als Parameter an die DLL für benutzerdefinierte Skripterstellung übergeben, wenn RAS die Implementierung von RasCustomScriptExecute der DLL aufruft.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile ras.h

Weitere Informationen

Benutzerdefinierte RAS-Skripterstellung

RasCustomScriptExecute

RasReceiveBuffer

RasSendBuffer