Provides script language access to C++ objects of this type.
Function members are as follows:
Return Type | Function Name | Documentation |
---|---|---|
int32 | ConsumeConfigNodes | Performs a breadth first search of a node hierarchy and for all ConfigNode-derived types, populates a <NodeBuffer> with a non-owning pointer to the ConfigNode and populates a <StrList> with the absolute path represented by the ConfigNode. This method is specifically designed to offer enhanced performance for this operation in Scenome Scripting Language. |
string | GetAbsolutePath | Returns a string containing the absolute path from the ConfigNode expression root to this <Node> by accumulating base path parameters. |
string | GetRelativePath | Returns a string containing the relative path from the ConfigNode expression root to this <Node> by accumulating base path parameters. First, the absolute path is calculated and then this path is made relative to the current document path. For example: the accumulated path C:\MyFile\MyDocument.Box will be made relative to the document path C:\MyDocuments\MyOtherDocument.box. |
Object members are as follows:
Type Name | Accessor Name | Documentation |
---|---|---|
string | BasePath | Gets or sets the base path parameter. The base path parameter at the root level must be an absolute path such as C:\MyDirectory. Base path values below a root level ConfigNode object should have paths such as AnotherDirectory. The final resolved path would be C:\MyDirectory\AnotherDirectory. |
string | BuildFunction | Gets or sets the build function parameter. The build function parameter should be the name of an Scenome Scripting Language function to invoke when the generic Build command is executed. |
int32 | BuildMode | Gets or sets the build mode. The build mode refers to the BuildModeOption enum, which supports options for Debug and Release modes. |
int32 | DefaultPath | Gets or sets the default path parameter. The default path parameter refers to the DefaultPath enum. |
string | DestinationDirectory | Gets or sets the destination directory string for this <Node>. |
int32 | Enterprise | Sets or gets the Enterprise flag, which indicates this node or subclasses refer to content required by Scenome Enterprise Edition. |
int32 | Personal | Sets or gets the Enterprise flag, which indicates this node or subclasses refer to content required by Scenome Personal Edition. |
int32 | Professional | Sets or gets the Enterprise flag, which indicates this node or subclasses refer to content required by Scenome Professional Edition. |
string | RelativeAddress | Gets or sets the <ConfigNode> object's relative address, which is the relative path from the current document to the base path. |
int32 | ShowInformation | Gets or sets the ShowInformation flag. The ShowInformation flag can be used by build process functions to determine if the build process emits information in the output window ( or other information ) during a build. The actual result of setting this flag is largely defined by the underlying command implementation. Some build processes may not be designed to emit information to the user. |
int32 | ShowWarnings | Gets or sets the ShowWarnings flag. The ShowWarnings flag can be used by build process functions to determine if the build process emits warnings in the output window ( or other information ) during a build. The actual result of setting this flag is largerly defined by the underlying command implementation. Some build processes may not be designed to emit warning information to the user. |
string | SourceDirectory | Gets or sets the source directory string for this <Node>. |