PFNRASRETRIEVEBUFFER 回呼函式 (ras.h)

  • 發行項

自定義腳本 DLL 會呼叫 RasRetrieveBuffer 函 式，以透過指定的埠從 RAS 伺服器接收資料。 自定義腳本 DLL 只有在 RAS 發出呼叫 RasReceiveBuffer 的訊號之後，才應該呼叫 RasRetrieveBuffer。

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 只有在 RAS 已向 RasReceiveBuffer 呼叫時，才會呼叫 RasRetrieveBuffer 事件物件。

自定義腳本 DLL 會透過函式指標呼叫 RasRetrieveBuffer 。 當 RAS 呼叫 RAsCustomScriptExecute 的 DLL 實作時，函式指標會以參數的形式傳遞至自定義腳本 DLL。

規格需求

需求 值
最低支援的用戶端 Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限桌面應用程式]
目標平台 Windows
標頭 ras.h

另請參閱

RAS 自定義腳本

RasCustomScriptExecute

RasReceiveBuffer

RasSendBuffer