beautypg.com

Port object macros, Port object macros -36 – Clear-Com Logic-Maestro User Manual

Page 102

background image

Clear-Com Communication Systems

Eclipse Logic Maestro Instruction Manual

2 - 3 6

PORT OBJECT MACROS

These macros are accessed by expanding the ‘Clearcom’ > ‘Entities’ >
‘PortObject’ entry in the Available Modules menu.

Macro

Description

Equals (Object) [bool]

Tests the equivalence of two objects and returns True or
False. e.g:
bool = .equals<(object2)>

GetHashCode () [int]

Returns the hash code of an object previously created
by a control as an integer. e.g:
int = .GetHashCode()

GetType () [Type]

Returns the type of an object previously created by a
control macro. e.g.
Type = .GetType()

ToString () [string]

Returns the string value of an object previously created
by a control macro. e.g.
string = .ToString();

CC_ADV_TYPE [Destination
Type]

Gets or sets the port type according to the parameter
details selected from a menu e.g.
.CC_ADV_TYPE = Type>.CC_ADV_PORT;

CombinedLabel[string]

Returns the port Talk/Listen label specified by the string
e.g.
PortObject = .Combin-
edLabel;

ConfigurationID [Guid]

Sets or returns the configuration ID of an object created
by a control macro as a control object e.g.
ControlObject = .Configuratio-
nID;
or
.ConfigurationID = ;

Description [string]

Sets or returns the description of a port as a string e.g.
.Description = ;
or
PortObject = .Description;

EnableListenAssign [bool]

Sets or returns the permission to assign a port as Listen
using a boolean e.g.
.EnableListenAssign = True;
or
PortObject = .EnableListe-
nAssign;