SDK Home Glossary Index Left Right Up

Machine Information V1


Section contents


Overview

Defined in

ce32base.oxh

Description

<TBS>


Construction / destruction


NewMachineInfoV1 - Constructor

Usage

this& = NewMachineInfoV1&:

Description

Creates a machine info V1 object and returns a handle which allows the object to be manipulated.

Return Value
this& An value which represents the created size, or 0 if creation failed
Example
  LOCAL this&

  this& = NewMachineInfoV1&:
  DeleteMachineInfoV1:(this&) 

DeleteMachineInfoV1 - Destructor

Usage

DeleteMachineInfoV1:(this&)

Description

Destroys the machine info V1 object.

Arguments
this& A handle to a machine info V1 object
Example
  LOCAL this&

  this& = NewMachineInfoV1&:
  DeleteMachineInfoV1:(this&) 

Methods provided


MachineInfoV1AfterResolution

Usage

microseconds& = MachineInfoV1AfterResolution&:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
this& <TBS>

MachineInfoV1BacklightPresent

Usage

bool% = MachineInfoV1BacklightPresent%:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
bool% Return KTrue% if a backlight is present, otherwise returns KFalse%

MachineInfoV1DisplayId

Usage

id& = MachineInfoV1DisplayId&:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
id& <TBS>

MachineInfoV1DisplayName

Usage

name$ = MachineInfoV1DisplayName$:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
name$ <TBS>
Error Handling

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


MachineInfoV1DisplaySizeInPixel

Usage

size& = MachineInfoV1DisplaySizeInPixel:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
size& A handle to a Size object. The handle must be frred by the caller when it is no longer required
Error Handling

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


MachineInfoV1KeyboardId

Usage

id& = MachineInfoV1KeyboardId&:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
id& <TBS>

MachineInfoV1KeyboardName

Usage

name$ = MachineInfoV1KeyboardName$:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
name$ <TBS>
Error Handling

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


MachineInfoV1KeyboardPresent

Usage

bool% = MachineInfoV1KeyboardPresent%:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
bool% Return KTrue% if a keyboard is present, otherwise returns KFalse%

MachineInfoV1LedCapabilities

Usage

capabilities& = MachineInfoV1LedCapabilities:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
capabilities& <TBS>

MachineInfoV1MachineName

Usage

name$ = MachineInfoV1MachineName$:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
name$ <TBS>
Error Handling

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


MachineInfoV1MachineUniqueId

Usage

id& = MachineInfoV1MachineUniqueId&:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
id& <TBS>
Error Handling

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


MachineInfoV1MaximumColors

Usage

colors& = MachineInfoV1MaximumColors&:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
id& <TBS>
Error Handling

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


MachineInfoV1OffsetToDisplay

Usage

point& = MachineInfoV1OffsetToDisplay&:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
point& A handle to a point object. The handle should be freed by the caller when it is no longer required.
Error Handling

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


MachineInfoV1ProcessorClockInKHz

Usage

name& = MachineInfoV1ProcessorClockInKHz&:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
name$ <TBS>
Error Handling

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


MachineInfoV1ProcessorName

Usage

name$ = MachineInfoV1ProcessorName$:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
name$ <TBS>
Error Handling

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


MachineInfoV1PsuName

Usage

name$ = MachineInfoV1PsuName$:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
name$ <TBS>
Error Handling

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


MachineInfoV1RomVersion

Usage

version& = MachineInfoV1RomVersion&:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
version& A handle to a version object
Error Handling

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


MachineInfoV1SpeedFactor

Usage

speed& = MachineInfoV1SpeedFactor&:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
version& A handle to a version object
Error Handling

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


MachineInfoV1XYInputName

Usage

name$ = MachineInfoV1XYInputName$:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
name$ <TBS>
Error Handling

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


MachineInfoV1XYInputPresent

Usage

bool% = MachineInfoV1XYInputPresent%:(this&)

Description

<TBS>

Arguments
this& A handle to a machine info V1object
Return value
bool% Return KTrue% if an XY input device is present, otherwise returns KFalse%

  SDK Home Glossary Index Left Right Up