UID type


Section contents


Overview

Defined in

ce32base.oxh

Description

<TBS>


Construction / destruction


NewUidType - Constructor

Usage

this& = NewUidType&:(uid1&,uid2&,uid3&)

Description

Creates a UID type object and returns a handle which allows the object to be manipulated.

Parameters
uid1& The first UID
uid2& The second UID
uid3& The third UID
Return Value
this& An value which represents the created UID type object
Error Handling

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

Example
  LOCAL this&

  this& = NewUidType&:(1,0,0)
  DeleteUidType:(this&) 

DeleteUidType - Destructor

Usage

DeleteUidType:(BYREF this&)

Description

Destroys the UID type object.

Arguments
this& A handle to a UID type object
Example
  LOCAL this&

  this& = NewUidType&:(1,0,0)
  DeleteUidType:(this&) 

Methods provided


UidTypeEQ - whether same UID type

Usage

bool% = UidTypeEQ%:(this&,uidType&)

Description

Determines whether the UID type objects this& and uidType& are the same.

Arguments
this& A handle to a version object
uidType& A handle to a version object
Return value
bool% Returns KTrue% (-1) if the objects are the same, otherwise returns KFalse% (0)

UidTypeGet - get UID

Usage

uid& = UidTypeGet&:(this&,index%)

Description

Gets the UID whose index is index&.

Arguments
this& A handle to a version object
index% The index of the UID to get. Must be between 0 and 2
Return value
uid& The UID

UidTypeIsPresent - whether the UID is present

Usage

bool% = UidTypeIsPresent%:(this&,uid&)

Description

Determines whether the UID uid& is present.

Arguments
this& A handle to a version object
uid& A UID
Return value
bool% Returns KTrue% (-1) if the UID is present, otherwise returns KFalse% (0)

UidTypeIsValid - whether the UID is valid

Usage

bool% = UidTypeIsValid%:(this&,uid&)

Description

Determines whether the UIDs in this& are valid.

Arguments
this& A handle to a version object
Return value
bool% Returns KTrue% (-1) if the valid UIDs are present, otherwise returns KFalse% (0)

UidTypeMostDerived - the most derived UID

Usage

uid& = UidTypeMostDerived&:(this&)

Description

Returns the most derived (specific) UID present.

Arguments
this& A handle to a version object
Return value
uid& The most derived UID

UidTypeNE - whether different UID type

Usage

bool% = UidTypeNE%:(this&,uidType&)

Description

Determines whether the UID type objects this& and uidType& are different.

Arguments
this& A handle to a version object
uidType& A handle to a version object
Return value
bool% Returns KTrue% (-1) if the objects are different, otherwise returns KFalse% (0)