xInfo.getDocNode Method [AX 2012]
Retrieves the specified documentation nodes from the AOT.
public TreeNode getDocNode(
UtilFileType helpType,
int UtilType,
str Name,
[UtilElementId ParentId,
int Type,
UtilEntryLevel UtilLevel,
boolean ForceLevel,
int Mode,
boolean OldUtil])
Run On
CalledParameters
- helpType
- Type: UtilFileType Enumeration
The documentation node that you want to use.
- UtilType
- Type: int
The subnode that you want to use within the helpType node.
- Name
- Type: str
The name of the node.
- ParentId
- Type: UtilElementId Extended Data Type
The handle for the parent; optional.
- Type
- Type: int
The type of node.
- UtilLevel
- Type: UtilEntryLevel Enumeration
The layer from which to get the node.
- ForceLevel
- Type: boolean
A Boolean value that indicates whether for force a get on the layer that is specified by the UtilLevel parameter.
- Mode
- Type: int
Reserved.
- OldUtil
- Type: boolean
A Boolean value that indicates whether to retrieve the node from the old AOT in the oldAOT folder.
The possible values for the helpType parameter are values of the UtilFileType system enumeration:
-
KernelHelp: the System Documentation node
-
ApplicationHelp: the Application Documentation node
-
ApplicationCodeDocumentation: the Application Developer Documentation node.
An example value of the utilType parameter is the Functions node within the System Documentation node.
The default value of the ForceLevel parameter is false. If it is set to false, and there is no content in the layer specified, the node will be taken from the next layer below this that does have content. If it is set to true, and there is no content in the layer, the method will return nullNothingnullptrunita null reference (Nothing in Visual Basic).