SIO_TCP_INFO控制項程式碼

發行項
06/12/2023

Description

SIO_TCP_INFO控制程式代碼會擷取指定通訊端的傳輸控制通訊協定 (TCP) 統計資料。

若要執行這項作業，請使用下列參數呼叫 WSAIoctl 或 WSPIoctl 函式。

int WSAIoctl(
  (socket) s,             // descriptor identifying a socket
  SIO_TCP_INFO,                // dwIoControlCode
  (LPVOID) lpvInBuffer,   // pointer to a DWORD
  (DWORD) cbInBuffer,    // size, in bytes, of the input buffer
  (LPVOID) lpvOutBuffer,         // pointer to a TCP_INFO_v0 structure
  (DWORD) cbOutBuffer,       // size of the output buffer
  (LPDWORD) lpcbBytesReturned,    // number of bytes returned
  (LPWSAOVERLAPPED) lpOverlapped,   // OVERLAPPED structure
  (LPWSAOVERLAPPED_COMPLETION_ROUTINE) lpCompletionRoutine,  // completion routine
);

int WSPIoctl(
  (socket) s,             // descriptor identifying a socket
  SIO_TCP_INFO,                // dwIoControlCode
  (LPVOID) lpvInBuffer,   // pointer to a DWORD
  (DWORD) cbInBuffer,           // size, in bytes, of the input buffer
  (LPVOID) lpvOutBuffer,         // pointer to a TCP_INFO_v0 structure
  (DWORD) cbOutBuffer,       // size of the output buffer
  (LPDWORD) lpcbBytesReturned,    // number of bytes returned
  (LPWSAOVERLAPPED) lpOverlapped,   // OVERLAPPED structure
  (LPWSAOVERLAPPED_COMPLETION_ROUTINE) lpCompletionRoutine,  // completion routine
  (LPWSATHREADID) lpThreadId,   // a WSATHREADID structure
  (LPINT) lpErrno   // a pointer to the error code.
);

參數

s

識別通訊端的描述項。

dwIoControlCode

作業的控制程式代碼。針對此作業使用 SIO_TCP_INFO 。

lpvInBuffer

輸入緩衝區的指標。此參數包含 DWORD 的指標，指定您使用之 SIO_TCP_INFO 控制項程式碼的版本。指定 0 以使用 TCP_INFO_v0。指定 1 以使用 TCP_INFO_v1，以提供更多欄位。

cbInBuffer

輸入緩衝區的大小，以位元組為單位。此參數應該是 DWORD 資料類型的大小。

lpvOutBuffer

輸出緩衝區的指標。在成功輸出時，此參數包含包含指定通訊端之 TCP 統計資料 之TCP_INFO_v0 結構的指標。

cbOutBuffer

輸出緩衝區的大小，以位元組為單位。此參數至少必須是 TCP_INFO_v0 結構的大小。

lBytesReturned

變數的指標，可接收儲存在輸出緩衝區中的資料大小，以位元組為單位。

如果輸出緩衝區太小，則呼叫會失敗， WSAGetLastError 會傳回 WSAEINVAL， 而lBytesReturned 參數會指向零的 DWORD 值。

如果lpOverlapped為Null，則成功呼叫時所傳回之 lmicrosoftBytesReturned參數所指向的DWORD值不能為零。

如果重迭通訊端的 lpOverlapped 參數不是 Null ，則會起始無法立即完成的作業，而且稍後會指出完成。傳回之lHTTPBytesReturned參數所指向的DWORD值可能是零，因為儲存的資料大小在重迭作業完成之前無法判斷。當作業完成時發出適當的完成方法訊號時，可以擷取最終完成狀態。

lpvOverlapped

WSAOVERLAPPED結構的指標。

如果沒有重迭屬性建立通訊端，則會忽略 lpOverlapped參數。

如果使用重迭屬性開啟 s ，且 lpOverlapped 參數不是 Null，則會以重迭的 (非同步) 作業來執行作業。在此情況下， lpOverlapped 參數必須指向有效的 WSAOVERLAPPED 結構。

對於重迭的作業， WSAIoctl 或 WSPIoctl 函式會立即傳回，並在作業完成時發出適當的完成方法訊號。否則，在作業完成或發生錯誤之前，函式不會傳回。

lpCompletionRoutine

類型：_In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE

當作業完成時呼叫的完成常式指標， (忽略非重迭通訊端) 。

lpThreadId

WSATHREADID結構的指標，供提供者在後續呼叫WPUQueueApc時使用。提供者應該儲存參考的 WSATHREADID 結構， (在 WPUQueueApc 函式傳回之前，不要儲存相同) 的指標。

注意此參數僅適用于 WSPIoctl 函式。

lpErrno

錯誤碼的指標。

注意此參數僅適用于 WSPIoctl 函式。

傳回值

如果作業順利完成， WSAIoctl 或 WSPIoctl 函式會傳回零。

如果作業失敗或擱置中，WSAIoctl 或 WSPIoctl函式會傳回SOCKET_ERROR。若要取得擴充錯誤資訊，請呼叫 WSAGetLastError。

錯誤碼	意義
WSAEMSGSIZE	輸入緩衝區的指標為 Null，或輸入緩衝區的指定大小不正確。
WSAEINVAL	提供的引數無效。如果 dwIoControlCode 參數不是有效的命令，或無法接受指定的輸入參數，或命令不適用於指定的通訊端類型，就會傳回此錯誤。