This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%Atelier.v2.Utils.General

class %Atelier.v2.Utils.General extends %Library.RegisteredObject

Method Inventory

Methods

classmethod GetMetaDataFromDocArray(ByRef pTextArray As %String, Output pName As %String, Output pKeywords As %String) as %Status
Method GetMetaDataFromDocArray locates a document header, parses it and extracts the meta data. The arguments are:
  • pTextArray - An integer indexed array of source lines
  • pName - Variable by reference to contain item name
  • pKeywords - Array by reference to contain attribute values indexed by keyword strings.
  • pKeywords("$ROUTINEline") - will be filled in with line number if a UDL ROUTINE header is located.

Returns a %Status value.

classmethod ValidLANG(pMode As %String, ByRef pKeywords As %String) as %String
ValidLANG(pMode,pKeyword) checks that a LanguageMode attribute is valid. If the mode is valid then it is inserted into the pKeywords array (passed by reference) and returned as the result of ValidLANG

If the mode is invalid then ValidLANG returns "".

Note: If the pKeywords array contains a conflicting Type value or a conflicting LanguageMode value then the mode attribute is invalid.

classmethod ValidType(pType As %String, ByRef pKeywords As %String) as %String
ValidType(pType,pKeyword) checks that a Type attribute is valid. If the type is valid then it is changed to upper case, inserted into the pKeywords array (passsed by reference) and returned as the result of ValidType

If the type is invalid then ValidType returns "".

Note: If the pKeywords array contains a conflicting Type value or a conflicting LanguageMode value then the Type attribute is invalid.

Inherited Members

Inherited Methods

Feedback