KsReadFile

此函式是否可用依裝置支援項目而定。

如可用,從 COM 埠讀取資料。

語法

BOOL KsReadFile(
     HANDLE hFile,
     LPVOID lpBuffer,
     DWORD nNumberOfBytesToRead,
     LPDWORD lpNumberOfBytesRead,
     LPOVERLAPPED lpOverlapped
);

參數

Value:欲讀取的連接埠。

lpBuffer:接收從檔案讀取之數據的緩衝區指標。

nNumberOfBytesToRead:欲從檔案讀取的位元組數量。

lpNumberOfBytesRead:讀取的位元組數量的指標。KsReadFile 在未執行任何動作或檢查錯誤時將此值設為零。

lpOverlapped(不支援):此參數必須設置為 NULL。

回傳值

若函式執行成功將回傳 TRUE;失敗將回傳 FALSE。欲獲取延伸錯誤資訊請呼叫 GetLastError

注意:若回傳值為 TRUE 且位元組數為零,則在讀取作業時沒有欲讀取的資料。

備註

回傳 KsReadFile 當請求的位元組數已被讀取或發生錯誤。

若檔案的一部分被另一個處理序鎖定且讀取作業與鎖定部分重疊,則此函式將執行失敗。

在讀取作業完成之前,應用程式不得讀取或寫入讀取作業正在使用的輸入緩衝區,過早訪問輸入緩衝區可能會導致讀入該緩衝區的資料毀損。

當同步讀取作業到達檔案最末端, KsReadFile 將回傳 TRUE 並設定 *lpNumberOfBytesRead 為零。

範例

N/A

使用需求

  RT Win32
最低支援版本 4.0 4.0
標頭檔 kscom.h kscom.h
程式庫 KsApi_Rtss.lib ksapi.h

參見

KsWriteFile