IPM
Global Class Reference
Inheritance diagram for Global:
Inheritance graph

Public Member Functions

_.Library.Status OnPhase (_.Library.String pPhase, pParams, _.Library.Boolean pResourceHandled)
 Called as phase pPhase is executed for the resource. More...
 
- Public Member Functions inherited from Abstract
 OnGetStudioProject (_.Studio.Project pProject, _.Library.Boolean pHandled)
 Subclasses may override to customize the studio project. More...
 
 OnGetUniqueName (pUniqueName)
 Returns a unique name for this resource. More...
 
_.Library.String OnItemRelativePath (_.Library.String pItemName)
 Returns the path relative to the module root for item pItemName within this resource.
 

Public Attributes

 Directory
 Directory relative to module root containing the exported resource. More...
 
 Global
 Optional name of global within the file. More...
 
 Preserve
 If set to 1, do not delete the global when the module is cleaned/uninstalled. More...
 
- Public Attributes inherited from Abstract
 Params
   More...
 

Static Public Attributes

 ATTRIBUTES = None
 Comma-separated list of resource attribute names that this processor uses.
 
 DESCRIPTION = None
 Description of resource processor class (shown in UI)
 
- Static Public Attributes inherited from Abstract
 ATTRIBUTES = None
 Comma-separated list of resource attribute names that this processor uses.
 
 DESCRIPTION = None
 Description of resource processor class (shown in UI)
 

Member Function Documentation

◆ OnPhase()

_.Library.Status OnPhase ( _.Library.String  pPhase,
  pParams,
_.Library.Boolean  pResourceHandled 
)

Called as phase pPhase is executed for the resource.

If pResourceHandled is set to true,

then the default behavior for that resource will be bypassed in the current phase. Currently, this is only used in the Verify phase, because of different handling of intermediate error statuses. TODO: Implement for standard database resources (.INC, .CLS, etc.)

Reimplemented from Abstract.

Member Data Documentation

◆ Directory

Directory

Directory relative to module root containing the exported resource.

Defaults to the resource's extension (lower-case) if unspecified.  

◆ Global

Optional name of global within the file.

 

◆ Preserve

Preserve

If set to 1, do not delete the global when the module is cleaned/uninstalled.