SDK Home Glossary Index Left Right Up

Socket option inet routing information


Section contents


Overview

Defined in

csocket.oxh


Construction / destruction


NewSoInetRouteInfo - Create a route information object

Usage

this& = NewSoInetRouteInfo&:

Description

Create a route information objects and returns a handle to the created object.

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

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


DeleteSoInetRouteInfo - Destroys the route information object

Usage

DeleteSoInetRouteInfo:(BYREF this&)

Description

Destroys the route information object.

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

Methods provided


SoInetRouteInfoDstAddr - Get the destination address

Usage

addr& = SoInetRouteInfoDstAddr&:(this&)

Description

Returns the destination internet address held in the route information object.

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

SoInetRouteInfoGateway - Get the gateway address

Usage

addr& = SoInetRouteInfoGateway&:(this&)

Description

Returns the gateway address held in the route information object.

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

SoInetRouteInfoIfAddr - Get the interface address

Usage

addr& = SoInetRouteInfoIfAddr&:(this&)

Description

Returns the interface address held in the route information object.

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

SoInetRouteInfoMetric - Get the route metric

Usage

metric& = SoInetRouteInfoMetric&:(this&)

Description

Returns the route metric (cost of using this route) held in the route information object.

Arguments
this& A handle to a route information object
Return value
metric& The metric (cost) of using this route

SoInetRouteInfoNetMask - Get the route net mask

Usage

addr& = SoInetRouteInfoNetMask&:(this&)

Description

Returns the net mask held in the route information object.

Arguments
this& A handle to a route information object
Return value
addr& A handle to a internet address object which specifies the netmask used for this route

SoInetRouteInfoSetDstAddr - Set the destination address

Usage

SoInetRouteInfoSetDstAddr:(this&,addr&)

Description

Sets the destination internet address in the route information object.

Arguments
this& A handle to a route information object
addr& A handle to a internet address object which specifies the destination address used for this route

SoInetRouteInfoSetGateway - Set the gateway address

Usage

SoInetRouteInfoSetGateway:(this&,addr&)

Description

Sets the gateway address in the route information object.

Arguments
this& A handle to a route information object
addr& A handle to a internet address object which specifies the gateway address used for this route

SoInetRouteInfoSetIfAddr - Set the interface address

Usage

SoInetRouteInfoSetIfAddr:(this&,addr&)

Description

Sets the interface address in the route information object.

Arguments
this& A handle to a route information object
addr& A handle to a internet address object which specifies the interface address used for this route

SoInetRouteInfoSetMetric - Set the route metric

Usage

SoInetRouteInfoSetMetric:(this&,metric&)

Description

Sets the route metric (cost of using) in the route information object.

Arguments
this& A handle to a route information object
metric& The metric (cost) used for this route

SoInetRouteInfoSetNetMask - Set the net mask

Usage

SoInetRouteInfoSetNetMask:(this&,addr&)

Description

Sets the net mask address in the route information object.

Arguments
this& A handle to a route information object
addr& A handle to a internet address object which specifies the netmask address used for this route

SoInetRouteInfoSetState - Set the route state

Usage

SoInetRouteInfoSetState:(this&,state&)

Description

Sets the route state in the route information object.

Arguments
this& A handle to a route information object
state& The route state for this route

SoInetRouteInfoSetType - Set the route type

Usage

SoInetRouteInfoSetType:(this&,type&)

Description

Sets the route type in the route information object.

Arguments
this& A handle to a route information object
type& The route type for this route

SoInetRouteInfoState - Get the route state

Usage

state& = SoInetRouteInfoState&:(this&)

Description

Returns the route state held in the route information object.

Arguments
this& A handle to a route information object
Return value
state& The state of this route

SoInetRouteInfoType - Get the route type

Usage

type& = SoInetRouteInfoType&:(this&)

Description

Returns the route type held in the route information object.

Arguments
this& A handle to a route information object
Return value
type& The route type of this route

  SDK Home Glossary Index Left Right Up