FUNCTION copyFile(sourceFile$, destFile$, eraseOK)
Copy file and optionally erase the original after the copy has completed. If
this method is executed within the Eclipse plug-in context, the resource will
also be refreshed so that Eclipse will be made aware of the file change.
|
Parameter | Description |
sourceFile$ |
The file to copy |
destFile$ |
The file to replace or create from the source file |
eraseOK |
A boolean flag to indicate if the source file should be deleted after the copy. |
|
FUNCTION dumpPrefixLists(aFN)
Dump Prefix List to specified file channel
|
Parameter | Description |
aFN |
A file channel to write prefix information (must be serial file) |
|
FUNCTION findText(aString$, aSearchText$)
Locate an occurrence of aSearchText$ in aString$ that does not appear within quotes.
|
Parameter | Description |
aString$ |
The string to be searched |
aSearchText$ |
The text to locate. |
|
Returns |
The position of first occurrence. |
|
FUNCTION getFileModTime$(aFile$)
Get the modification time stamp for a file
|
Parameter | Description |
aFile$ |
The full path to the file to be checked |
|
Returns |
A string value containing the modification time stamp for the file in the format "YYYY/MM/DD HH:MM:SS" |
|
FUNCTION getWorkFile$(aNamePfx$)
Generate a name for a new work file (cannot exist) and use the Operating System default
temporary directory.
|
Parameter | Description |
aNamePfx$ |
The start of the work file name. |
|
Returns |
The full path name of a work file that can be created by the application. |
|
FUNCTION getWorkFile$(aNamePfx$, aWorkDir$, aFileExt$)
Generate a name for a new work file (cannot exist) in the work directory specified.
|
Parameter | Description |
aNamePfx$ |
The start of the work file name. |
aWorkDir$ |
The directory where the work file will be created; if not set, will use the temporary directory for the OS |
aFileExt$ |
The file extension to be added to the file name (default is "tmp") |
|
Returns |
The full path name of a work file that can be created by the application. |
|
FUNCTION stripBlockComments$(inText$)
Remove an C-style block comments from the text.
|
Parameter | Description |
inText$ |
A block of text that is to have the block comments stripped. |
|
Returns |
A block of text without the C-style block comments. |
|
FUNCTION stripBlockComments$(inText$, inReplaceChar$)
Replace the contents of a C-style block comment with the specified replacement character.
|
Parameter | Description |
inText$ |
A block of text that is to have the block comments stripped. |
inReplaceChar$ |
A character to be substituted for the block comment |
|
Returns |
A block of text without the C-style block comments. |
|
FUNCTION stripPvxDocHeaderInfo$(inText$)
Strip the ProvideX documentation header information.
|
Parameter | Description |
inText$ |
A block of text that may have the PvxDoc tag information stripped. |
|
Returns |
A block of text without the PvxDoc tag information. |
|
FUNCTION stripPvxDocTagInfo$(inText$)
Strip the ProvideX documentation tag information where the documentation prefix is '! *-'.
|
Parameter | Description |
inText$ |
A block of text that is to have the PvxDoc tag information stripped. |
|
Returns |
A block of text without the PvxDoc tag information. |
|
FUNCTION stripPvxDocTagInfo$(inText$, inDocTag$)
Strip the ProvideX documentation tag information where the documentation prefix is '! *-' and allow forced stripping of the header tag information.
|
Parameter | Description |
inText$ |
A block of text that is to have the PvxDoc tag information stripped. |
inDocTag$ |
The documentation tag to be removed. |
|
Returns |
A block of text without the PvxDoc tag information. |
|
FUNCTION stripStringLiterals$(inText$)
Remove a String Literal from the text.
|
Parameter | Description |
inText$ |
A block of text to be processed |
|
Returns |
A block of text without String Literals |
|
FUNCTION stripStringLiterals$(inText$, inReplaceChar$)
Replace the contents of a String Literal with the specified replacement character.
|
Parameter | Description |
inText$ |
A block of text tto be processed |
inReplaceChar$ |
A character to be substituted for the String Literal |
|
Returns |
A block of text without the StringLiterals |
|