簡述:
控制套接口的模式。
#include <winsock.h>
int PASCAL FAR ioctlsocket( SOCKET s, long cmd, u_long FAR* argp);
s:一個標識套接口的描述字。
cmd:對套接口s的操作命令。
argp:指向cmd命令所帶參數的指針。
注釋:
本函數可用于任一狀態的任一套接口。它用于獲取與套接口相關的操作參數,而與具體協議或通訊子系統無關。支持下列命令:
FIONBIO:允許或禁止套接口s的非阻塞模式。argp指向一個無符號長整型。如允許非阻塞模式則非零,如禁止非阻塞模式則為零。當創建一個套接口時,它就處于阻塞模式(也就是說非阻塞模式被禁止)。這與BSD套接口是一致的。WSAAsynSelect()函數將套接口自動設置為非阻塞模式。如果已對一個套接口進行了WSAAsynSelect() 操作,則任何用ioctlsocket()來把套接口重新設置成阻塞模式的試圖將以WSAEINVAL失敗。為了把套接口重新設置成阻塞模式,應用程序必須首先用WSAAsynSelect()調用(IEvent參數置為0)來禁至WSAAsynSelect()。
FIONREAD:確定套接口s自動讀入的數據量。argp指向一個無符號長整型,其中存有ioctlsocket()的返回值。如果s是SOCKET_STREAM類型,則FIONREAD返回在一次recv()中所接收的所有數據量。這通常與套接口中排隊的數據總量相同。如果S是SOCK_DGRAM 型,則FIONREAD返回套接口上排隊的第一個數據報大小。
SIOCATMARK:確實是否所有的帶外數據都已被讀入。這個命令僅適用于SOCK_STREAM類型的套接口,且該套接口已被設置為可以在線接收帶外數據(SO_OOBINLINE)。如無帶外數據等待讀入,則該操作返回TRUE真。否則的話返回FALSE假,下一個recv()或recvfrom()操作將檢索“標記”前一些或所有數據。應用程序可用SIOCATMARK操作來確定是否有數據剩下。如果在“緊急”(帶外)數據前有常規數據,則按序接收這些數據(請注意,recv()和recvfrom()操作不會在一次調用中混淆常規數據與帶外數據)。argp指向一個BOOL型數,ioctlsocket()在其中存入返回值。
兼容性:
本函數為Berkeley套接口函數ioctl()的一個子集。其中沒有與FIOASYNC等價的命令,SIOCATMARK是套接口層次支持的唯一命令。
返回值:
成功后,ioctlsocket()返回0。否則的話,返回SOCKET_ERROR錯誤,應用程序可通過WSAGetLastError()獲取相應錯誤代碼。
錯誤代碼:
WSANOTINITIALISED:在使用此API之前應首先成功地調用WSAStartup()。
WSAENETDOWN:WINDOWS套接口實現檢測到網絡子系統失效。
WSAEINVAL:cmd為非法命令,或者argp所指參數不適用于該cmd命令,或者該命令
不適用于此種類型的套接口。
WSAEINPROGRESS:一個阻塞的WINDOWS套接口調用正在運行中。
WSAENOTSOCK:描述字不是一個套接口。
參見:
socket(), setsockopt(), getsockopt(), WSAAsyncSelect().