GetPubHeaderXmlDoc
Syntax
GetPubHeaderXmlDoc(PubID, PubNode, ChannelName, VersionName[, Segment])
Description
Use the GetPubHeaderXmlDoc function to retrieve the message header from the message queue.
Note: This function has been deprecated and remains for backward compatibility only. Use the IntBroker class GetMessage method instead.
The message header, also known as the message instance, is ...
GetPubXmlDoc
Syntax
GetPubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubNode [, Segment])
Description
Use the GetPubXmlDoc function to retrieve a message from the message queue.
Note: This function has been deprecated and remains for backward compatibility only. Use the IntBroker class GetMessage method instead.
This is the message after any transformations have been ...
GetRatingBoxChart
Syntax
GetRatingBoxChart(RecordName.FieldName)
Description
Use the GetRatingBoxChart function to get a reference to an RatingBoxChart class object.
A chart must be associated with a record and field merely so that the chart object can be instantiated in PeopleCode. Which record and field you use doesn't matter. Commonly, the ...
GetRatingGauge
Syntax
GetRatingGauge(RecordName.FieldName)
Description
Use the GetRatingGauge function to get a reference to a RatingGaugeChart object.
A gauge must be associated with a record and field merely so that the gauge object can be instantiated in PeopleCode. While the record and field you use doesn't matter, for a ...
GetRatingGaugeState
Syntax
GetRatingGaugeState()
Description
Use the GetRatingGaugeState function to get a reference to a RatingGaugeState object. A RatingGaugeState object can then be associated with the corresponding state property on the RatingGaugeChart object.
Parameters
None.
Returns
A reference to a RatingGaugeState object.
GetRecord
Syntax
GetRecord([RECORD.recname])
Description
Use the GetRecord function to create a reference to a record object for the current context, that is, from the row containing the currently executing program.
The following code:
&REC = GetRecord();is equivalent to:
&REC = GetRow().GetRecord(Record.recname);or
&REC = GetRow().recname;Note: This ...
GetReferenceArea
Syntax
GetReferenceArea()
Description
Use the GetReferenceArea function to get a reference to a ReferenceArea object. ReferenceArea instances can then be associated with a Chart object.
Parameters
None.
Returns
A reference to a ReferenceArea object.
Example
&MyRefArea = GetReferenceArea();
GetReferenceLine
Syntax
GetReferenceLine()
Description
Use the GetReferenceLine function to get a reference to a ReferenceLine object. ReferenceLine instances can then be associated with a Chart object.
Parameters
None.
Returns
A reference to a ReferenceLine object.
Example
&MyRefLine = GetReferenceLine();
GetRelField
Syntax
GetRelField(ctrl_field, related_field)
Description
Use the GetRelField function to retrieve the value of a related display field and returns it as an unspecified (Any) data type.
Note: This function remains for backward compatibility only. Use the GetRelated field class method instead.
The field ctrl_field specifies the display control field ...
GetRow
Syntax
GetRow()
Description
Use the GetRow function to obtain a row object for the current context, that is the row containing the currently executing program.
Using the GetRow function is equivalent to:
&ROW = GetRowset().GetRow(CurrentRowNumber());Note: For PeopleCode programs located in events that are not associated with a specific ...