CAsyncSocket::GetSockOpt

BOOL GetSockOpt ( int nOptionName, void ※ lpOptionValue, int ※ lpOptionLen, int nLevel = SOL_SOCKET );

戻り値

関数が成功したそうでなければ 0、および具体的なエラーコードGetLastErrorの呼び出し取得できます。オプションはSetSockOptを設定した場合は、 GetSockOptオプションの既定値を返します。このメンバー関数を次のエラーを適用します。:

WSANOTINITIALISED特価;成功AfxSocketInitがこの API を使用する前に行う必要があります。(&N)。
WSAENETDOWN特価;Windows ソケットの実装、ネットワークサブシステムが失敗したことが検出されました(&N)。
WSAEFAULT特価;LpOptionLen引数が無効でした。(&N)。
WSAEINPROGRESS特価;ブロックの Windows ソケット操作が進行中であります。(&N)。
WSAENOPROTOOPT特価;オプションは不明またはサポートされていないです。SO_ACCEPTCONN、 SO_DONTLINGER、 SO_KEEPALIVE、 SO_LINGER、 SO_OOBINLINE型SOCK_DGRAMのソケットではサポートされていませんが具体的には、 SO_BROADCAST型SOCK_STREAMのソケットでサポートされていません(&N)。
特価; wsaenotsock が返されるディスクリプターはソケットではないです。(&N)。

パラメーター

nOptionName

値を取得するソケットオプション。

lpOptionValue

要求されたオプションの値が返されるバッファーへのポインター。選択したオプションに関連付けられた値はバッファー lpOptionValueで返されます。LpOptionLenが指す整数はもともと、このバッファーのバイト単位のサイズを含める必要があります;戻り値には、それは返される値のサイズに設定されます。SO_LINGERは、これはリンガー構造体のサイズになります;他のすべてのオプションをBOOLのint、オプションに応じてサイズになります。オプションと「解説」セクションのサイズの一覧を参照してください。

lpOptionLen

LpOptionValueバッファーのバイト単位のサイズへのポインター。

nLevel

オプションで定義されているレベル;サポートされているレベルだけSOL_SOCKETとIPPROTO_TCPです。

解説

ソケットオプションを取得するにはこのメンバー関数を呼び出します。GetSockOpt任意の状態での任意のタイプのソケットに関連付けられたソケットオプションの現在の値を取得し、 lpOptionValueで保存します。オプションで、帯域外のデータ転送、パケットのルーティングなど、ソケットの操作に影響を与える。

GetSockOptは、次のオプションをサポートします。種類lpOptionValueによって対応するデータの種類を識別します。TCP_NODELAYオプションレベルのIPPROTO_TCPを使用して;レベルSOL_SOCKETの他のすべてのオプションを使用します。

値	タイプ	意味
SO_ACCEPTCONN	BOOL	ソケットがリッスンしています。
SO_BROADCAST	BOOL	ソケットのブロードキャストメッセージの送信の構成します。
SO_DEBUG	BOOL	デバッグが有効になっています。
SO_DONTLINGER	BOOL	True の場合、 SO_LINGERオプションは無効です。
SO_DONTROUTE	BOOL	ルーティングが無効になっています。
SO_ERROR	int	エラーステータスを取得し、クリア。
SO_KEEPALIVE	BOOL	キープアライブ送信されています。
SO_LINGER	構造体残留	現在のリンガオプションを返します。
SO_OOBINLINE	BOOL	帯域外のデータは、通常のデータストリームで受信されています。
SO_RCVBUF	int	バッファーサイズを受信します。
SO_REUSEADDR	BOOL	既に使用されているアドレスにソケットをバインドすることができます。
SO_SNDBUF	int	バッファーサイズを送信します。
SO_TYPE	int	ソケット (たとえば、 SOCK_STREAM) の種類。
TCP_NODELAY	BOOL	送信結合用の Nagle アルゴリズムを無効にします。

GetSockOptのサポートされていない Berkeley Software Distribution (BSD) オプションします。:

値	タイプ	意味
SO_RCVLOWAT	int	低水位マークを受信します。
SO_RCVTIMEO	int	タイムアウトを受信します。
SO_SNDLOWAT	int	低水位マークを送信します。
SO_SNDTIMEO	int	タイムアウトを送信します。
IP_OPTIONS		IP ヘッダーにオプションを得る。
TCP_MAXSEG	int	TCP 最大セグメントサイズを取得します。

GetSockOptがサポートされていないオプションを呼び出し、 GetLastErrorから返されるWSAENOPROTOOPTのエラーコードになります。

CAsyncSocket 概要|nbsp;クラスメンバー |階層図(&N)

参照特価;CAsyncSocket::SetSockOpt(&N)

Index