IPM
LocalizedMessages Class Reference
Inheritance diagram for LocalizedMessages:
Inheritance graph

Static Public Member Functions

_.Library.String GetIncludeFileName (_.Library.String pDocumentName)
 Given a full error message document name (with .LOC extension), returns the full name (with extension) of the associated .INC file.
 
_.Library.String GetOther (_.Library.String Name)
 Return other document types that this is related to. More...
 
_.Library.Status OnDelete (_.Library.String name)
 Deletes the include file associated with this document.
 
- Static Public Member Functions inherited from Abstract
_.Library.TimeStamp CompileTime (_.Library.String name)
 Return the compile time of routine 'name' in TimeStamp format. More...
 
_.Library.Status Delete (_.Library.String name)
 Deletes the instance of ..#<parameter>STREAMCLASS</parameter> identified by name
 
_.Library.Boolean Exists (_.Library.String name)
 Return 1 if the given document exists and 0 if it does not.
 
_.Library.Status ImportStream (_.Library.String pName, _.Library.GlobalCharacterStream pStream)
 Saves the document in pStream to the database as an instance of ..#<parameter>STREAMCLASS</parameter>, with name pName
 
_.Library.Status LockName (_.Library.String name)
 Called from Library.RoutineMgr:LockItem to lock a document by name (including extension)
 
_.Library.TimeStamp TimeStamp (_.Library.String name)
 Return the timestamp of schema category 'name' in TimeStamp format, i.e. More...
 
_.Library.Status UnlockName (_.Library.String name)
 Called from Library.RoutineMgr:UnlockItem to unlock a document by name (including extension)
 

Additional Inherited Members

- Public Member Functions inherited from Abstract
_.Library.Status CompileDocument (_.Library.String qstruct)
 CompileDocument is called when the document is to be compiled. More...
 
_.Library.Status ExportToXML (_.Library.String flags)
 Export this document to the current device in XML format.
 
_.Library.Status ImportFromXML (_.Library.RegisteredObject stream, _.Library.String flags)
 Import from the stream in XML format.
 
_.Library.Status Load ()
 Loads the instance of ..#<parameter>STREAMCLASS</parameter> identified by <property>Name</property> into the stream <property>Code</property>
 
_.Library.Status Lock (_.Library.String flags)
 Lock the current routine, default method just unlocks the ^ROUTINE global with the name of the routine. More...
 
_.Library.Status Save ()
 Save the module definition document.
 
_.Library.Status Unlock (_.Library.String flags)
 Unlock the current routine, default method just unlocks the ^ROUTINE global with the name of the routine.
 
- Static Public Attributes inherited from Abstract
 STREAMCLASS = None
 Optional subclass of IPM.StudioDocument.AbstractStream that stores code in a character stream.
 

Member Function Documentation

◆ GetOther()

_.Library.String GetOther ( _.Library.String  Name)
static

Return other document types that this is related to.

Passed a name and you return a comma separated list of the other documents it is related to or "" if it is not related to anything. Note that this can be passed a document of another type for example if your 'test.XXX' document creates a 'test.INT' routine then it will also be called with 'test.INT' so you can return 'test.XXX' to complete the cycle.