BBjTriggerData::getFileComment

Description

In BBj 9.0 and higher, this method returns the comment set in a VKEYED file's header using the setText() method on the BBjFileInfo object.

Syntax

Return Value	Method
string	getFileComment()

Parameters

None.

Return Value

The optional comment set in a VKEYED file's header.

Remarks

This method is only valid when called on VKEYED files.

Example

rem 'Get the Trigger object from the BBj File System

td! = BBjAPI().getFileSystem().getTriggerData()

rem 'Get the file comment
comment$ = td!.getFileComment()