Unit Network

Return to Unit Reference

Description

---

To be documented

Constants

---

To be documented

Type definitions

---

To be documented

Public variables

---

To be documented

Function declarations

---

Initialization functions

[Expand]

procedure NetworkInit;

Description: To be documented

Note	To be documented

[Expand]

function NetworkStart:LongWord;

Description: To be documented

Note	To be documented

[Expand]

function NetworkStop:LongWord;

Description: To be documented

Note	To be documented

[Expand]

function NetworkStartCompleted:Boolean;

Description: To be documented

Return	Returns True if the network sub system has been started

Network functions

[Expand]

function NetworkDeviceOpen(Network:PNetworkDevice):LongWord;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceClose(Network:PNetworkDevice):LongWord;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceRead(Network:PNetworkDevice; Buffer:Pointer; Size:LongWord; var Length:LongWord):LongWord;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceWrite(Network:PNetworkDevice; Buffer:Pointer; Size:LongWord; var Length:LongWord):LongWord;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceControl(Network:PNetworkDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;

Description: To be documented

Note	To be documented

[Expand]

function NetworkBufferAllocate(Network:PNetworkDevice; var Entry:PNetworkEntry):LongWord;

Description: Allocate a transmit buffer from the specified network device, the returned entry will include a buffer for writing data to as well as an offfset value to allow the driver data to be written to the start of the buffer. When the data has been copied to the buffer, pass the entry to NetworkBufferTransmit.

Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function NetworkBufferRelease(Network:PNetworkDevice; Entry:PNetworkEntry):LongWord;

Description: Release a receive buffer to the specified network device, the entry must have been returned from NetworkBufferReceive

Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function NetworkBufferReceive(Network:PNetworkDevice; var Entry:PNetworkEntry):LongWord;

Description: Receive a completed receive buffer from the specified network device. The returned entry will contain a one or more packets of data to read from. When the data has been processed pass the returned buffer to NetworkBufferRelease.

Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function NetworkBufferTransmit(Network:PNetworkDevice; Entry:PNetworkEntry):LongWord;

Description: Transmit a completed transmit buffer to the specified network device. The entry must have been allocated using NetworkBufferAllocate.

Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function NetworkDeviceSetState(Network:PNetworkDevice; State:LongWord):LongWord;

Description: Set the state of the specified network and send a notification

Network	The network to set the state for
State	The new state to set and notify
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function NetworkDeviceSetStatus(Network:PNetworkDevice; Status:LongWord):LongWord;

Description: Set the status of the specified network and send a notification

Network	The network to set the status for
Status	The new status to set and notify
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function NetworkDeviceCreate:PNetworkDevice;

Description: Create a new Network entry

Return	Pointer to new Network entry or nil if network could not be created

[Expand]

function NetworkDeviceCreateEx(Size:LongWord):PNetworkDevice;

Description: Create a new Network entry

Size	Size in bytes to allocate for new network (Including the network entry)
Return	Pointer to new Network entry or nil if network could not be created

[Expand]

function NetworkDeviceDestroy(Network:PNetworkDevice):LongWord;

Description: Destroy an existing Network entry

Note	To be documented

[Expand]

function NetworkDeviceRegister(Network:PNetworkDevice):LongWord;

Description: Register a new Network in the Network table

Note	To be documented

[Expand]

function NetworkDeviceDeregister(Network:PNetworkDevice):LongWord;

Description: Deregister a Network from the Network table

Note	To be documented

[Expand]

function NetworkDeviceFind(NetworkId:LongWord):PNetworkDevice;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceFindByName(const Name:String):PNetworkDevice; inline;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceFindByDescription(const Description:String):PNetworkDevice; inline;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceEnumerate(Callback:TNetworkEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceNotification(Network:PNetworkDevice; Callback:TNetworkNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	To be documented

[Expand]

function NetworkEventAllocate(Callback:TNetworkEventCallback; Data:Pointer; Event:LongWord):PNetworkEvent;

Description: Create and Register a new Event entry in the Event table

Note	To be documented

[Expand]

function NetworkEventRelease(Event:PNetworkEvent):LongWord;

Description: Deregister and Destroy a Event from the Event table

Note	To be documented

[Expand]

function NetworkEventRegister(Callback:TNetworkEventCallback; Data:Pointer; Event:LongWord):THandle;

Description: Register a callback for one or more network events

Note	To be documented

[Expand]

function NetworkEventDeregister(Handle:THandle):LongWord;

Description: Deregister a network event callback

Note	To be documented

[Expand]

function NetworkEventNotify(Event:LongWord):LongWord;

Description: To be documented

Note	To be documented

RTL network functions

[Expand]

function SysHostGetName:String;

Description: To be documented

Note	To be documented

[Expand]

function SysHostSetName(const AName:String):Boolean;

Description: To be documented

Note	To be documented

[Expand]

function SysHostGetDomain:String;

Description: To be documented

Note	To be documented

[Expand]

function SysHostSetDomain(const ADomain:String):Boolean;

Description: To be documented

Note	To be documented

Network helper functions

[Expand]

function NetworkGetCount:LongWord; inline;

Description: Get the current network count

Note	To be documented

[Expand]

function NetworkDeviceCheck(Network:PNetworkDevice):PNetworkDevice;

Description: Check if the supplied Network is in the network table

Note	To be documented

[Expand]

function NetworkDeviceTypeToString(NetworkType:LongWord):String;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceStateToString(NetworkState:LongWord):String;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceStatusToString(NetworkStatus:LongWord):String;

Description: To be documented

Note	To be documented

[Expand]

function NetworkDeviceStateToNotification(State:LongWord):LongWord;

Description: Convert a Network state value into the notification code for device notifications

Note	To be documented

[Expand]

function NetworkDeviceStatusToNotification(Status:LongWord):LongWord;

Description: Convert a Network status value into the notification code for device notifications

Note	To be documented

[Expand]

function NetworkEventCheck(Event:PNetworkEvent):PNetworkEvent;

Description: Check if the supplied Event is in the event table

Note	To be documented

[Expand]

procedure NetworkLog(Level:LongWord; Network:PNetworkDevice; const AText:String);

Description: To be documented

Note	To be documented

[Expand]

procedure NetworkLogInfo(Network:PNetworkDevice; const AText:String);

Description: To be documented

Note	To be documented

[Expand]

procedure NetworkLogError(Network:PNetworkDevice; const AText:String);

Description: To be documented

Note	To be documented

[Expand]

procedure NetworkLogDebug(Network:PNetworkDevice; const AText:String);

Description: To be documented

Note	To be documented

[Expand]

function HardwareAddressToString(const AAddress:THardwareAddress):String;

Description: To be documented

Note	To be documented

[Expand]

function StringToHardwareAddress(const AAddress:String):THardwareAddress;

Description: To be documented

Note	To be documented

[Expand]

function CompareHardwareAddress(const AAddress1,AAddress2:THardwareAddress):Boolean;

Description: To be documented

Note	To be documented

[Expand]

function CompareHardwareDefault(const AAddress:THardwareAddress):Boolean;

Description: To be documented

Note	To be documented

[Expand]

function CompareHardwareBroadcast(const AAddress:THardwareAddress):Boolean;

Description: To be documented

Note	To be documented

[Expand]

function CompareHardwareMulticast(const AAddress:THardwareAddress):Boolean;

Description: To be documented

Note	To be documented

[Expand]

function AdapterTypeToString(AType:Word):String;

Description: To be documented

Note	To be documented

[Expand]

function AdapterModeToString(AMode:Word):String;

Description: To be documented

Note	To be documented

[Expand]

function AdapterConfigToString(AConfig:Word):String;

Description: To be documented

Note	To be documented

[Expand]

function AdapterStateToString(AState:Integer):String;

Description: To be documented

Note	To be documented

[Expand]

function AdapterStatusToString(AStatus:Integer):String;

Description: To be documented

Note	To be documented

[Expand]

function FrameTypeToString(AType:Word):String;

Description: To be documented

Note	To be documented

[Expand]

function MediaTypeToString(AType:Word):String;

Description: To be documented

Note	To be documented

[Expand]

function PacketTypetoString(AType:Word):String;

Description: To be documented

Note	To be documented

[Expand]

function ConfigTypeToString(AType:Word):String;

Description: To be documented

Note	To be documented

[Expand]

function ConfigCommandToString(ACommand:Word):String;

Description: To be documented

Note	To be documented

[Expand]

function AuthTypeToString(AType:Word):String;

Description: To be documented

Note	To be documented

[Expand]

function AuthCommandToString(ACommand:Word):String;

Description: To be documented

Note	To be documented

Return to Unit Reference