SDK Home Glossary Index Left Right Up

Socket option interface information


Section contents


Overview

Defined in

csocket.oxh


Construction / destruction


NewSoInetInterfaceInfo - Create an interface information object

Usage

this& = NewSoInetInterfaceInfo&:

Description

Create an interface information object and returns a handle to the created object.

Return Value
this& A handle which represents the created interface information object
Error Handling

If the object could not be created then an error is generated which should be trapped by an ONERR handler.


DeleteSoInetInterfaceInfo - Destroys the interface information object

Usage

DeleteSoInetInterfaceInfo:(BYREF this&)

Description

Destroys the interface information object.

Arguments
BYREF this& A handle to an interface information object. A zero value is written back into the variable

Methods provided


SoInetInterfaceInfoAddress - Get the interface address

Usage

addr& = SoInetInterfaceInfoAddress&:(this&)

Description

Returns the interface address held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
addr& A handle to a internet address object

SoInetInterfaceInfoBrdAddr - Get the broadcast address

Usage

addr& = SoInetInterfaceInfoBrdAddr&:(this&)

Description

Returns the broadcast address held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
addr& A handle to a internet address object

SoInetInterfaceInfoDefGate - Get the default gateway address

Usage

addr& = SoInetInterfaceInfoDefGate&:(this&)

Description

Returns the default gateway address held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
addr& A handle to a internet address object

SoInetInterfaceInfoFeatures - Get the interface features

Usage

features& = SoInetInterfaceInfoFeatures&:(this&)

Description

Returns the interface features held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
features& Interface features

SoInetInterfaceInfoHwAddr - Get the hardware address

Usage

addr& = SoInetInterfaceInfoHwAddr&:(this&)

Description

Returns the hardware address held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
addr& A handle to a socket address object

SoInetInterfaceInfoMtu - Get the Mtu

Usage

mtu& = SoInetInterfaceInfoMtu&:(this&)

Description

Returns the MTU held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
mtu& The MTU

SoInetInterfaceInfoName - Get the interface name

Usage

name$ = SoInetInterfaceInfoName$:(this&)

Description

Returns the interface name held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
name$ The interface name
Error Handling

If the name$ string cannot be created then an error is generated which should be trapped by an ONERR handler.


SoInetInterfaceInfoNameSer1 - Get the first name service address

Usage

addr& = SoInetInterfaceInfoNameSer1&:(this&)

Description

Returns the first name service server address held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
addr& A handle to a internet address object for the first name service server

SoInetInterfaceInfoNameSer2 - Get the second name service address

Usage

addr& = SoInetInterfaceInfoNameSer2&:(this&)

Description

Returns the second name service server address held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
addr& A handle to a internet address object for the second name service server

SoInetInterfaceInfoNetMask - Get the interface net mask

Usage

addr& = SoInetInterfaceInfoNetMask&:(this&)

Description

Returns the net mask held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
addr& A handle to a internet address object

SoInetInterfaceInfoSetAddress - Set the interface address

Usage

SoInetInterfaceInfoSetAddress:(this&,addr&)

Description

Sets the interface address held in the interface information object.

Arguments
this& A handle to an interface information object
addr& A handle to a internet address object

SoInetInterfaceInfoSetBrdAddr - Set the broadcast address

Usage

SoInetInterfaceInfoSetBrdAddr:(this&,addr&)

Description

Sets the broadcast address held in the interface information object.

Arguments
this& A handle to an interface information object
addr& A handle to a internet address object

SoInetInterfaceInfoSetDefGate - Set the default gateway address

Usage

SoInetInterfaceInfoSetDefGate:(this&,addr&)

Description

Sets the default gateway address held in the interface information object.

Arguments
this& A handle to an interface information object
addr& A handle to a internet address object

SoInetInterfaceInfoSetFeatures - Set the interface features

Usage

SoInetInterfaceInfoSetFeatures:(this&,features&)

Description

Sets the interfacet features held in the interface information object.

Arguments
this& A handle to an interface information object
features& The interface features

SoInetInterfaceInfoSetHwAddr - Set the hardware address

Usage

SoInetInterfaceInfoSetHwAddr:(this&,addr&)

Description

Sets the hardware address held in the interface information object.

Arguments
this& A handle to an interface information object
addr& A handle to a socket address object

SoInetInterfaceInfoSetMtu - Set the interface mtu

Usage

SoInetInterfaceInfoSetMtu:(this&,mtu&)

Description

Sets the interfacet MTU held in the interface information object.

Arguments
this& A handle to an interface information object
mtu& The interface MTU

SoInetInterfaceInfoSetName - Set the interface name

Usage

SoInetInterfaceInfoSetName:(this&,str$)

Description

Sets the interfacet name held in the interface information object.

Arguments
this& A handle to an interface information object
name$ The interface name

SoInetInterfaceInfoSetNameSer1 - Set the first name service address

Usage

SoInetInterfaceInfoSetNameSer1:(this&,addr&)

Description

Sets the first name service address held in the interface information object.

Arguments
this& A handle to an interface information object
addr& A handle to a internet address object

SoInetInterfaceInfoSetNameSer2 - Set the second name service address

Usage

SoInetInterfaceInfoSetNameSer2:(this&,addr&)

Description

Sets the second name service address held in the interface information object.

Arguments
this& A handle to an interface information object
addr& A handle to a internet address object

SoInetInterfaceInfoSetNetMask - Set the interface net mask

Usage

SoInetInterfaceInfoSetNetMask:(this&,addr&)

Description

Sets the net mask held in the interface information object.

Arguments
this& A handle to an interface information object
addr& A handle to a internet address object

SoInetInterfaceInfoSetSpeedMetric - Set the interface speed metric

Usage

SoInetInterfaceInfoSetSpeedMetric:(this&,metric&)

Description

Sets the interfacet speed metric held in the interface information object.

Arguments
this& A handle to an interface information object
metric& The interface speed metric

SoInetInterfaceInfoSetState - Set the interface state

Usage

SoInetInterfaceInfoSetState:(this&,state&)

Description

Sets the interfacet state held in the interface information object.

Arguments
this& A handle to an interface information object
state& The interface state

SoInetInterfaceInfoSetTag - Set the interface tag

Usage

SoInetInterfaceInfoSetTag:(this&,str$)

Description

Sets the interfacet tag held in the interface information object.

Arguments
this& A handle to an interface information object
str$ The interface tag

SoInetInterfaceInfoSpeedMetric - Get the interface speed metric

Usage

metric& = SoInetInterfaceInfoSpeedMetric&:(this&)

Description

Returns the MTU held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
metric& The speed metric

SoInetInterfaceInfoState - Get the interface state

Usage

state& = SoInetInterfaceInfoState&:(this&)

Description

Returns the interface state held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
state& The interface state

SoInetInterfaceInfoTag - Get the interface tag

Usage

tag$ = SoInetInterfaceInfoTag$:(this&)

Description

Returns the interface tag held in the interface information object.

Arguments
this& A handle to an interface information object
Return value
tag$ The interface tag
Error Handling

If the tag$ object cannot be created then an error is generated which should be trapped by an ONERR handler.


  SDK Home Glossary Index Left Right Up