Class header_entity

This class is used to store build information that is defined within the beginning (header) of a source file.

Build Information

Author fmcguirk
Date 2007.03.15 11 at 03:34:27 PM EDT
Outputfile header_entity.pvc
Forcelinenumbers false

Properties

PROPERTY _version$

Methods

FUNCTION exists()

Returns A simple boolean (0=False, 1=True) to indicate that information was found in the source file.
FUNCTION getAuthor$()

Returns The value found after the '@Author' tag
FUNCTION getDate$()

Returns The value found after the '@Date' tag
FUNCTION getFlags$()

Returns The value found after the '@Flags' tag
FUNCTION getForceLineNumbers$()

Returns The value found after the '@ForceLineNumbers' tag
FUNCTION getLineNumberInc()

Returns The line number increment (if valid) found after the '@LineNumberInc' tag
FUNCTION getOutputFile$()

Returns The value found after the '@OutputFile' tag
FUNCTION getOwner()

Returns The value found after the '@Owner' tag
FUNCTION getPassword$()

Returns The value found after the '@Password' tag
FUNCTION setAuthor$(inAuthor$)

Store the value associated with the '@Author' tag

ParameterDescription
inAuthor$ The remainder of the line after the tag
FUNCTION setDate$(inDate$)

Store the value associated with the '@Date' tag

ParameterDescription
inAuthor$ The remainder of the line after the tag
FUNCTION setFlags$(inFlags$)

Store the value associated with the '@Flags' tag

ParameterDescription
inAuthor$ The remainder of the line after the tag
FUNCTION setForceLineNumbers$(inBoolean$)

Store the value associated with the '@ForceLineNumbers' tag

ParameterDescription
inAuthor$ The remainder of the line after the tag
FUNCTION setLineNumberInc$(aValue$)

Store the value associated with the '@LineNumberInc' tag if valid

ParameterDescription
inLineInc$ The line number increment (a number between 1 and 25)
Returns The line number increment (if valid) found after the '@LineNumberInc' tag
FUNCTION setOutputFile$(inFile$)

Store the value associated with the '@OutputFile' tag

ParameterDescription
inAuthor$ The remainder of the line after the tag
FUNCTION setOwner(inOwner)

Store the value associated with the '@Owner' tag

ParameterDescription
inAuthor$ The remainder of the line after the tag
FUNCTION setPassword$(inPassword$)

Store the value associated with the '@Password' tag

ParameterDescription
inAuthor$ The remainder of the line after the tag