首页 > 代码库 > ioctlsocket()函数是干什么用的?它返回值是什么?共有几个参数?它的各个参数是干什么用的?
ioctlsocket()函数是干什么用的?它返回值是什么?共有几个参数?它的各个参数是干什么用的?
1. ioctlsocket()
简述:
控制套接口的模式。
#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().
ioctlsocket
The Windows Sockets ioctlsocket function controls the I/O mode of a socket.
int ioctlsocket(
SOCKET s,
long cmd,
u_long FAR *argp
);
Parameters
s
[in] Descriptor identifying a socket.
cmd
[in] Command to perform on the socket s.
argp
[in, out] Pointer to a parameter for cmd.
Return Values
Upon successful completion, the ioctlsocket returns zero. Otherwise, a value of SOCKET_ERROR is returned, and a specific error code can be retrieved by calling WSAGetLastError.
Error code Meaning
WSANOTINITIALISED A successful WSAStartup call must occur before using this function.
WSAENETDOWN The network subsystem has failed.
WSAEINPROGRESS A blocking Windows Sockets 1.1 call is in progress, or the service provider is still processing a callback function.
WSAENOTSOCK The descriptor s is not a socket.
WSAEFAULT The argp parameter is not a valid part of the user address space.