NSPROTO_IPX Socket Options

The following tables describe NSPROTO_IPX socket options that apply to sockets created for the IPX/SPX address family (AF_IPX). See the getsockopt and setsockopt function reference pages for more information on getting and setting socket options.

To enumerate protocols and discover supported properties for each installed protocol, use the WSAEnumProtocols, WSCEnumProtocols, or WSCEnumProtocols32 function.

NSPROTO_IPX Socket Options
OptionGetSetOptval typeDescription
IPX_ADDRESSyesIPX_ADDRESS_DATAReturns information about the specific adapter that IPX is enabled on.
IPX_ADDRESS_NOTIFYyesIPX_ADDRESS_DATAAsynchronously notifies when the status of an IPX adapter changes.
IPX_DSTYPEyesyesDWORDGets or sets the value of the datastream field in the SPX header to send packets with.
IPX_EXTENDED_ADDRESSyesDWORD (boolean)Enables the extended addressing option on IPX packets.
IPX_FILTERPTYPEyesyesDWORDGets or sets the current IPX receive filter packet type. Only IPX packets with a packet type equal to the value specified in the optval parameter will be returned. Packets with a packet type that does not match are discarded. This is only applicable to a datagram socket.
IPX_GETNETINFOyesIPX_NETNUM_DATAReturns information regarding a specific IPX network number. The netnum member of the IPX_NETNUM_DATA structure must be set to the IPX network number to be returned.
IPX_GETNETINFO_NORIPyesIPX_NETNUM_DATAReturns information regarding a specific IPX network number without sending a RIP request. The netnum member of the IPX_NETNUM_DATA structure must be set to the IPX network number to be returned.
IPX_IMMEDIATESPXACKyesDWORD (boolean)If set to TRUE, do not delay sending ACKs on an SPX connection.
IPX_MAX_ADAPTER_NUMyesDWORDReturns the number of IPX enabled adapters present.
IPX_MAXSIZEyesDWORDReturns the maximum IPX datagram size in bytes that can be sent.
IPX_PTYPEyesyesDWORDGets or sets the packet type. The value specified in the optval parameter will be set as the packet type on every IPX packet sent from this socket.
IPX_RECEIVE_BROADCASTyesDWORD (boolean)If set to TRUE, receive broadcast IPX packets.
IPX_RECVHDRyesDWORD (boolean)If set to TRUE, receive IPX protocol headers with data.
IPX_RERIPNETNUMBERyesIPX_NETNUM_DATAReturns information regarding a specified IPX network number using a new RIP request. The netnum member of the IPX_NETNUM_DATA structure must be set to the IPX network number to be returned.
IPX_SPXGETCONNECTIONSTATUSyesIPX_SPXCONNSTATUS_DATAReturns information regarding a connected SPX socket statistics.
IPX_STOPFILTERPTYPEyesDWORDRemoves the filter and stops filtering on packet type specified in the optval parameter.

 

Windows Support for NSPROTO_IPX options
OptionWindows Vista and laterWindows Server 2003Windows XPWindows 2000Windows NT4Windows 9x/Me
IPX_ADDRESSxxxx x
IPX_ADDRESS_NOTIFYxxxxx
IPX_DSTYPExxxxx
IPX_EXTENDED_ADDRESSxxxxx
IPX_FILTERPTYPExxxxx
IPX_GETNETINFOxxxxx
IPX_GETNETINFO_NORIPxxxxx
IPX_IMMEDIATESPXACKxxxxx
IPX_MAX_ADAPTER_NUMxxxxx
IPX_MAXSIZExxxxx
IPX_PTYPExxxxx
IPX_RECEIVE_BROADCASTxxxxx
IPX_RECVHDRxxxxx
IPX_RERIPNETNUMBERxxxxx
IPX_SPXGETCONNECTIONSTATUSxxxxx
IPX_STOPFILTERPTYPExxxxx

 

The following NSPROTO_IPX socket options were defined in Windows Sockets 2 Protocol-Specific Annex, but are not implemented by the Windows IPX/SPX protocol.

level = NSPROTO_IPX

OptionTypeDefaultMeaning
IPX_CHECKSUMBooloffWhen set, IPX performs a checksum on outgoing packets and verifies the checksum of incoming packets.
IPX_TXPKTSIZEintMedia size to a maximum of 1466Sets the maximum send datagram size. This size does not include the IPX header or any media headers that may also be used. May be increased to media size.
IPX_RXPKTSIZEintMedia size to a maximum of 1466Sets the maximum receive datagram size. This size does not include the IPX header or any media headers that may also be used. May be increased to media size.
IPX_TXMEDIASIZEintPrimary boardReturns the send media size that sets an upper bound for datagram size.
IPX_RXMEDIASIZEintPrimary boardReturns the receive media size that sets an upper bound for datagram size.
IPX_PRIMARYBoolPrimaryRestricts traffic to the primary network board.

 

The following NSPROTO_SPX socket options were defined in Windows Sockets 2 Protocol-Specific Annex, but are not implemented on Windows by the Windows IPX/SPX protocol.

level = NSPROTO_SPX

OptionTypeDefaultMeaning
SPX_CHECKSUMBooloffWhen set, IPX performs a checksum on outgoing packets and verifies the checksum of incoming packets. Not supported on all platforms.
SPX_TXPKTSIZEintMedia size to a maximum of 1466Sets the maximum send datagram size. This size does not include the SPX header or any media headers that may also be used. May be increased to media size.
SPX_RXPKTSIZEintMedia size to a maximum of 1466Sets the maximum receive datagram size. This size does not include the SPX header or any media headers that may also be used. May be increased to media size.
SPX_TXMEDIASIZEintPrimary boardReturns the send media size minus SPX and media headers. This sets an upper bound for message segmentation packet size.
SPX_RXMEDIASIZEintPrimary boardReturns the receive media size minus SPX and media headers. This sets an upper bound for receive packet size.
SPX_RAWSPXBooloffWhen set, the IPX/SPX protocol header is passed with the data.

 

Remarks

The NSPROTO_IPX socket options and the structures used by these socket options are defined in the Wsnwlink.h header file.

Requirements

Header

Wsnwlink.h

 

 

Community Additions

ADD
Show:
© 2014 Microsoft