OV_ExternalNode::Create()
OV_ExternalNode::Create_Trans()
- OV_ExternalNode Create(
- [in] string Caption,
- [in] uint16 Type,
- [in] string Pattern,
- [in, optional] uint32 Order,
- [in, optional] boolean CheckBeforeManagedNodes,
- [in, optional] string Name,
- [in, optional] string ParentName,
- [in, optional] string Description)
- OV_ExternalNode Create_Trans(
- [in] string TransId,
- [in] string Caption,
- [in] uint16 Type,
- [in] string Pattern,
- [in, optional] uint32 Order,
- [in, optional] boolean CheckBeforeManagedNodes,
- [in, optional] string Name,
- [in, optional] string ParentName,
- [in, optional] string Description)
Parameters
- TransId
- Transaction ID returned from OV_Transaction::Start().
- Caption
- Caption (Display Name). If an external node with the same
Caption already exists on the same hierarchy path level (that is,
has the same parent), nothing happens, and the method fails with
MDLAPI_E_EXT_NODE_HIERPATH_EXISTS. If the Caption parameter is an
empty string, contains invalid characters, or has more then 1024
characters, the method fails with MDLAPI_E_INVALID_CAPTION.
- Type
- Defines the type of external node.
- Pattern
- Defines the string pattern that is used to evaluate whether an
incoming message belongs to an external node.
- Order
- Defines the order in which the external nodes are evaluated.
Optional parameter. Default is 0.
- CheckBeforeManagedNodes
- Defines whether the external node is checked before the managed
nodes. Optional property. Default is false.
- Name
- A Name property of an instance of OV_ExternalNode to be
created. Optional parameter. If you do not specify this parameter,
or if it is equal to an empty string, the method creates it as a
new GUID. If an external node with same Name already exists,
nothing happens, and the method fails with
MDLAPI_E_EXT_NODE_NAME_EXISTS.
- ParentName
- Name property of an instance of OV_NodeGroup to which a newly
created external node is added. Optional parameter. If you do not
specify this parameter, or if it is equal to an empty string, the
method uses the root node group. If the specified node group does
not exist, the method fails with
MDLAPI_E_PARENT_NODEGROUP_NOT_EXIST.
- Description
- The Description property of the instance of OV_ExternalNode to
be created. Optional parameter.
Calling Convention
These methods can be called from a WMI class or instance
object.
Description
Creates an external node (instance of OV_ExternalNode).
Return Value
Instance of the newly created OV_ExternalNode.
Extended Status Codes
- MDLAPI_E_INVALID_PARAMETER
- Parameter is not valid.
- MDLAPI_E_INVALID_CAPTION
- Specified object Caption parameter is not valid.
- MDLAPI_E_EXT_NODE_NAME_EXISTS
- External node with the same Name already exists.
- MDLAPI_E_EXT_NODE_HIERPATH_EXISTS
- External node with the same hierarchy path (Caption) already
exists.
- MDLAPI_E_PARENT_NODEGROUP_NOT_EXIST
- Parent node group does not exist.
- MDLAPI_E_NODEGROUP_SPECIAL_ADD
- Child cannot be added to a special node group.
- MDLAPI_E_TRANSACTION_NOT_EXIST
- Transaction with the specified ID does not exist.