次の方法で共有

PFNRASRETRIEVEBUFFER コールバック関数 (ras.h)

  • [アーティクル]

カスタム スクリプト DLL は RasRetrieveBuffer 関数を呼び出して、指定したポート経由で RAS サーバーから受信したデータを取得します。 カスタム スクリプト DLL は、 RAS が RasReceiveBuffer の呼び出しで渡されたイベント オブジェクトを通知した後にのみ 、RasRetrieveBuffer を呼び出す必要があります。

PFNRASRETRIEVEBUFFER 型は、このコールバック関数へのポインターを定義します。 RasRetrieveBuffer は、アプリケーション定義関数名のプレースホルダーです。

構文

PFNRASRETRIEVEBUFFER Pfnrasretrievebuffer;

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

パラメーター

hPort

データを受信するポートを処理します。 このハンドルは、 RasCustomScriptExecute 関数の最初のパラメーターとして RAS によって渡されるハンドルである必要があります。

pBuffer

hPort パラメーターで指定されたポートからデータを受信するバッファーへのポインター。 RasGetBuffer 関数を使用して、このバッファーを取得します。 このパラメーターの値は、 RasReceiveBuffer 関数に渡されるバッファーへのポインターと同じにすることができます。

pdwSize

pBuffer パラメーターが指すバッファーで返されるデータのサイズを受け取る DWORD 変数へのポインター。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS。

関数が失敗した場合、戻り値には次のいずれかのエラー コードを指定できます。

値 意味
ERROR_BUFFER_INVALID
 pBuffer パラメーターで渡されたバッファーへのポインターが無効です。
ERROR_INVALID_PORT_HANDLE
 hPort パラメーターで指定されたハンドルが無効です。
 

データがポストされる前に何らかの理由でポートが切断された場合、RAS はイベント オブジェクトに通知します。 この場合、 RasRetrieveBuffer は、エラーの原因を示す Raserror.h で定義されたエラーを返します。

注釈

RasRetrieveBuffer 関数は同期です。 が返されると、 pBuffer パラメーターが指すバッファーには、指定されたポートで受信したデータが含まれます。 カスタム スクリプト DLL は、 RAS が RasReceiveBuffer の呼び出しで DLL が渡したイベント オブジェクトを通知した後にのみ 、RasRetrieveBuffer を呼び出す必要があります。

カスタム スクリプト DLL は、関数ポインターを介して RasRetrieveBuffer を呼び出します。 RAS が RasCustomScriptExecute の DLL の実装を呼び出すと、関数ポインターがパラメーターとしてカスタム スクリプト DLL に渡されます。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー ras.h

こちらもご覧ください

RAS カスタム スクリプト

RasCustomScriptExecute

RasReceiveBuffer

RasSendBuffer