IRISLIB database
TextServices Class Reference

This class provides the external interface for retrieving, storing, and compiling documents representing classes, routines, and include files (amongst others). More...

Inheritance diagram for TextServices:
Collaboration diagram for TextServices:

Static Public Member Functions

_.Library.Status GetTextAsArray (_.Library.String pFullName, _.Library.Integer pFlags, _.Library.String pTextArray, _.Library.Boolean pBinary)
 This class provides the external interface for retrieving, storing, and compiling documents representing classes, routines, and include files (amongst others). More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

This class provides the external interface for retrieving, storing, and compiling documents representing classes, routines, and include files (amongst others).

Member Function Documentation

◆ GetTextAsArray()

_.Library.Status GetTextAsArray ( _.Library.String  pFullName,
_.Library.Integer  pFlags,
_.Library.String  pTextArray,
_.Library.Boolean  pBinary 
)
static

This class provides the external interface for retrieving, storing, and compiling documents representing classes, routines, and include files (amongst others).

Given a name, return an array of strings representing the document. On success the

returned <PARAMETER>pTextArray</PARAMETER> will have the 0 subscript set to the number of lines and the subscripts 1-n will contain the actual text.
Or, if the <PARAMETER>pBinary</PARAMETER> flag is set, the returned <PARAMETER>pTextArray</PARAMETER> will contain chunks of Base64-encoded data and the node pTextArray("bin") will be set to 1.
The <PARAMETER>pFlags</PARAMETER> parameter contains bit flags defined as:
Source format: 0 = UDL, 1 = XML, 2 = RO
Class storage section only: 8
Split method arguments one per line: 16