SDK Home Glossary Index Left Right Up

Socket option interface information


Section contents


Overview

Defined in

csocket.oxh

Description

An interface information entry.


Construction / destruction


NewSoIfInfo

Usage

this& = NewSoIfInfo&:

Description

Creates aninterface information object and returns a handle to the created object.

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

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


DeleteSoIfInfo

Usage

DeleteSoIfInfo:(BYREF this&)

Description

Destroys a socket interface information object.

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

Methods provided


SoIfInfoGetFeatures

Usage

features& = SoIfInfoGetFeatures&:(this&)

Description

Returns the feature flags.

Arguments
this& A handle to an interface information entry
Return value
features& A bitmask containg the socket interface feature flags
See Also

SoIfInfoSetFeatures


SoIfInfoGetMTU

Usage

mtu& = SoIfInfoGetMTU&:(this&)

Description

Returns the maximum frame size.

Arguments
this& A handle to an interface information entry
Return value
mtu& The maximum frame size
See Also

SoIfInfoSetMTU


SoIfInfoGetName

Usage

name$ = SoIfInfoGetName$:(this&)

Description

Returns the interface name.

Arguments
this& A handle to an interface information entry
Return value
name$ The interface name
See Also

SoIfInfoSetName


SoIfInfoGetSpeedMetric

Usage

speed& = SoIfInfoGetSpeedMetric&:(this&)

Description

Returns the speed metric which is an indication of performance (approximating to Kbps).

Arguments
this& A handle to an interface information entry
Return value
speed& The speed metric.
See Also

SoIfInfoSetSpeedMetric


SoIfInfoSetFeatures

Usage

SoIfInfoSetFeatures:(this&, features&)

Description

Set the features flags in the interface information object.

Arguments
this& A handle to an interface information entry
features& A bitmask of the socket interface feature flags.
See Also

SoIfInfoGetFeatures


SoIfInfoSetMTU

Usage

SoIfInfoSetMTU:(this&, size&)

Description

Set the features flags in the interface information object.

Arguments
this& A handle to an interface information entry
See Also

SoIfInfoGetFeatures


SoIfInfoSetName

Usage

SoIfInfoSetName:(this&, name$)

Description

Set the name in the interface information object. The name must not be longer the KMaxInterfaceName% characters long.

Arguments
this& A handle to an interface information entry
name$ The name of the interface.
See Also

SoIfInfoGetName


SoIfInfoSetSpeedMetric

Usage

SoIfInfoSetSpeedMetric:(this&, speed&)

Description

Set the speed metric in the interface information object.

Arguments
this& A handle to an interface information entry.
speed& The speed metric.
See Also

SoIfInfoGetSpeedMetric


  SDK Home Glossary Index Left Right Up