ICabNode::Insert Method
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 10: | Line 10: | ||
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT Insert([in, optional] VARIANT itemIdentity, | <pre class="brush:cpp;gutter:false">HRESULT Insert([in, optional] VARIANT itemIdentity, | ||
| − | [in, defaultvalue(dt_Invalid)] CabDataTypeID | + | [in, defaultvalue(dt_Invalid)] CabDataTypeID Type, |
| − | [out, retval] ICabNode** | + | [out, retval] ICabNode** Node);</pre> |
== Parameters == | == Parameters == | ||
| Line 19: | Line 19: | ||
For dictionary containers it specifies a string key to associate with the new node. If the dictionary already has a node with this key, the existing node will be returned. | For dictionary containers it specifies a string key to associate with the new node. If the dictionary already has a node with this key, the existing node will be returned. | ||
| − | ; | + | ;Type |
:[in, defaultvalue(dt_Invalid)] Value of [[PXV:CabDataTypeID|CabDataTypeID]]. | :[in, defaultvalue(dt_Invalid)] Value of [[PXV:CabDataTypeID|CabDataTypeID]]. | ||
Specifies the node type. | Specifies the node type. | ||
| Line 29: | Line 29: | ||
| − | ; | + | ;Node |
:[out, retval] Pointer to [[PXV:ICabNode|ICabNode]]. | :[out, retval] Pointer to [[PXV:ICabNode|ICabNode]]. | ||
The address of a pointer variable that receives the pointer to the resulting cab node. | The address of a pointer variable that receives the pointer to the resulting cab node. | ||
Revision as of 06:47, 12 June 2015
Inserts a new subnode into the container node.
Syntax
HRESULT Insert([in, optional] VARIANT itemIdentity,
[in, defaultvalue(dt_Invalid)] CabDataTypeID Type,
[out, retval] ICabNode** Node);
Parameters
- itemIdentity
- [in, optional] VARIANT.
Specifies the new node position. For array containers it is interpreted as an integer index the new node has to be inserted before. For dictionary containers it specifies a string key to associate with the new node. If the dictionary already has a node with this key, the existing node will be returned.
- Type
- [in, defaultvalue(dt_Invalid)] Value of CabDataTypeID.
Specifies the node type.
For templatized containers the type is checked against the container template.
When itemIdentity identifies an existing dictionary node, the type is checked against the existing node type.
If the type value is dt_Undefined, the type check semantics is actually a type resolution - the resulting node type is the type the checking is made against.
- Node
- [out, retval] Pointer to ICabNode.
The address of a pointer variable that receives the pointer to the resulting cab node.
Return Value
Returns S_OK if operation was successful or error code in other cases.
