Partager via


Fonction de rappel PFNRASRETRIEVEBUFFER (ras.h)

La DLL de script personnalisé appelle la fonction RasRetrieveBuffer pour obtenir les données reçues du serveur RAS sur le port spécifié. La DLL de script personnalisé doit appeler RasRetrieveBuffer uniquement après que RAS a signalé l’objet d’événement passé dans l’appel à RasReceiveBuffer.

Le type PFNRASRETRIEVEBUFFER définit un pointeur vers cette fonction de rappel. RasRetrieveBuffer est un espace réservé pour le nom de fonction défini par l’application.

Syntaxe

PFNRASRETRIEVEBUFFER Pfnrasretrievebuffer;

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

Paramètres

hPort

Gérez le port sur lequel recevoir les données. Ce handle doit être le handle transmis par RAS comme premier paramètre de la fonction RasCustomScriptExecute .

pBuffer

Pointeur vers une mémoire tampon pour recevoir les données du port spécifié par le paramètre hPort . Obtenez cette mémoire tampon à l’aide de la fonction RasGetBuffer . La valeur de ce paramètre peut être identique au pointeur vers la mémoire tampon passée dans la fonction RasReceiveBuffer .

pdwSize

Pointeur vers une variable DWORD qui reçoit la taille des données retournées dans la mémoire tampon vers laquelle pointe le paramètre pBuffer .

Valeur retournée

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

Si la fonction échoue, la valeur de retour peut être l’un des codes d’erreur suivants.

Valeur Signification
ERROR_BUFFER_INVALID
Le pointeur vers la mémoire tampon passée dans le paramètre pBuffer n’est pas valide.
ERROR_INVALID_PORT_HANDLE
Le handle spécifié par le paramètre hPort n’est pas valide.
 

RAS signale l’objet d’événement si le port est déconnecté pour une raison quelconque avant la publication des données. Dans ce cas, RasRetrieveBuffer retourne une erreur définie dans Raserror.h, qui indique la cause de l’échec.

Remarques

La fonction RasRetrieveBuffer est synchrone. Quand il retourne, la mémoire tampon pointée vers par le paramètre pBuffer contient les données reçues sur le port spécifié. La DLL de script personnalisé doit appeler RasRetrieveBuffer uniquement après que RAS a signalé l’objet d’événement que la DLL a passé dans l’appel à RasReceiveBuffer.

La DLL de script personnalisé appelle RasRetrieveBuffer via un pointeur de fonction. Le pointeur de fonction est passé à la DLL de script personnalisé en tant que paramètre lorsque RAS appelle l’implémentation de la DLL de RasCustomScriptExecute.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête ras.h

Voir aussi

Script personnalisé RAS

RasCustomScriptExecute

RasReceiveBuffer

RasSendBuffer