PeekNamedPipe

BooL，非零表示成功，零表示失敗。會設置GetLastError.

Declare Function PeekNamedPipe Lib "kernel32" Alias "PeekNamedPipe" (ByVal hNamedPipe As Long, lpBuffer As Any, ByVal nBufferSize As Long, lpBytesRead As Long, lpTotalBytesAvail As Long, lpBytesLeftThisMessage As Long) As Long

由這個函數讀入的數據實際並不能從管道中刪除。如果要對一個管道進行輪詢，瞭解是否有可讀數據，那麼使用這個函數特別理想.

函數原型：

BOOL WINAPI PeekNamedPipe(__in HANDLE hNamedPipe, //管道句柄__out_opt LPVOID lpBuffer, //讀取輸出緩衝區，可選__in DWORD nBufferSize, //緩衝區大小__out_opt LPDWORD lpBytesRead, //接收從管道中讀取數據的變量的指針，可選__out_opt LPDWORD lpTotalBytesAvail, //接收從管道讀取的字節總數__out_opt LPDWORD lpBytesLeftThisMessage);

hNamedPipe [in]

管道句柄。這個參數可以是一個命名管道實例句柄，返回，由CreateNamedPipe或CreateFile函數，或者它可以是一個匿名管道的讀端句柄，返回由CREATEPIPE功能。句柄必須有GENERIC_READ權限的管道。

lpBuffer [out, optional]

接收從管道讀取數據的緩衝區的指針。如果沒有數據要讀取，此參數可以為NULL。

nBufferSize [in]

lpBuffer參數以字節為單位，由指定的緩衝區大小。如果lpBuffer是NULL，則忽略此參數。

lpBytesRead [out, optional]

接收從管道中讀取的字節數的變量的指針。此參數可以為NULL，如果沒有數據要讀取。

lpTotalBytesAvail [out, optional]

一個指針變量，接收從管道讀取的字節總數。此參數可以為NULL，如果沒有數據要讀取。

lpBytesLeftThisMessage [out, optional]

指向剩餘的字節數的變量的指針消息。此參數將是零字節類型的命名管道或匿名管道。此參數可以為NULL，如果沒有數據要讀取。

如果函數成功，返回值為非零。

如果函數失敗，返回值是零。為了獲得更多錯誤信息，調用GetLastError。

PeekNamedPipe功能是類似ReadFile函數，有以下例外：

數據讀取與CreateNamedPipe指定的模式。例如，與PIPE_TYPE_MESSAGE創建一個管道| PIPE_READMODE_MESSAGE。如果你改變模式與SetNamedPipeHandleState PIPE_READMODE_BYTE的，ReadFile函數將讀取的字節模式，但PeekNamedPipe將繼續在消息模式讀取。

從管道讀取數據不會被刪除，從管道的緩衝區。

函數可以返回有關管內容的其他信息。

該函數總是返回立即在單線程應用程序，即使是在管道中沒有數據。等待一個命名管道句柄（阻塞或非阻塞）模式，在功能上沒有影響。

注意的PeekNamedPipe功能可以阻止線程執行任何I / O功能可以稱為同步處理時，在一個多線程的應用程序相同的方式。為了避免這種情況，使用異步I / O創建一個管道句柄

如果指定的句柄是一個字節的只讀模式命名管道句柄，函數讀取所有可用的字節在nBufferSize指定的大小。為命名管道句柄消息只讀模式，函數讀取管道中的下一個消息。如果消息是較大比nBufferSize，該函數返回TRUE讀取指定的字節數。在這種情況下，lpBytesLeftThisMessage將收到的消息中剩餘的字節數。