<div class="content" name="ApiCreateNodeEnumEx" uuid="ce7b4260-d851-4a42-866a-cf7e96d488a3"><p>(Protocol Version 3) The ApiCreateNodeEnumEx method SHOULD<a id="Appendix_A_Target_103"></a><a aria-label="Product behavior note 103" href="1d58eff8-a042-478c-972c-8e9c76a3f978#Appendix_A_103" data-linktype="relative-path">&lt;103&gt;</a> return two <span><a href="3b8f47c7-f694-4841-9aea-afa77184bbfa" data-linktype="relative-path">ENUM_LIST</a></span>
structures of equal length containing the <b>ID</b> and <b>Name</b> attributes
of the requested objects of the specified enumeration type from the <span><a href="694e5e7a-5833-4f3d-b47e-323ee1d452c2#gt_93ba0f62-7125-4a3e-ab60-5fd4f504bc8c" data-linktype="relative-path">cluster
state</a></span>. Each <b>Element</b> in the <i>ReturnIdEnum</i> parameter
corresponds to the ID of the element at the same offset in the <i>ReturnNameEnum</i>
parameter.</p><p>If multiple enumeration types are indicated, the resulting
ENUM_LIST contains zero or more entries of each type, and the type of each
entry in the lists are indicated by the <span><a href="fbc1bc18-45d4-4668-980d-ed639ea2f03e" data-linktype="relative-path">ENUM_ENTRY</a></span> data
structure, as specified in section 2.2.3.4.</p><p>The <span><a href="694e5e7a-5833-4f3d-b47e-323ee1d452c2#gt_434b0234-e970-4e8c-bdfa-e16a30d96703" data-linktype="relative-path">server</a></span> SHOULD accept
an ApiCreateNodeEnumEx request if its <span><a href="694e5e7a-5833-4f3d-b47e-323ee1d452c2#gt_a93e2fea-3006-4a06-b48f-fdb36d9abac9" data-linktype="relative-path">protocol server state</a></span>
is read-only, and the server MUST accept the request for processing if it is in
the read/write state, as specified in section <span><a href="756547e7-ca64-4b7c-9f1b-2b1fbc6153d3" data-linktype="relative-path">3.1.1</a></span>.</p><p>The server MUST fail this method with the
ERROR_INVALID_PARAMETER (0x00000057) return value if the <i>dwType</i>
parameter is not one of the specified values or if the <i>dwOptions</i>
parameter is not 0x00000000.</p><p>The server SHOULD accept an ApiCreateNodeEnumEx request if
the access level associated with the hNode context handle is at least
&#34;Read&#34; (section <span><a href="a249a463-3d3b-4058-abf6-3024d81806a0" data-linktype="relative-path">3.1.4</a></span>).</p><dl>
<dd>
<div><pre> error_status_t ApiCreateNodeEnumEx(
   [in] HNODE_RPC hNode,
   [in] DWORD dwType,
   [in] DWORD dwOptions,
   [out] PENUM_LIST* ReturnIdEnum,
   [out] PENUM_LIST* ReturnNameEnum,
   [out] error_status_t* rpc_status
 );
</pre></div>
</dd></dl><p><b>hNode: </b>An <span><a href="76c24b3c-2d90-49b4-86b0-68b14e683bf4" data-linktype="relative-path">HNODE_RPC</a></span> context
handle that was obtained in a previous ApiOpenNode (Opnum 66) or ApiOpenNodeEx
(Opnum 118) method call.</p><p><b>dwType: </b>The type of enumeration to be returned
by the server. This value MUST be set to the bitwise OR operator of one or more
of the following values:</p><dl>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Value</p>
   </th>
   <th>
   <p>Meaning</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>CLUSTER_NODE_ENUM_NETINTERFACES 0x00000001</td>
  <td>The server MUST return an enumeration of names, in ReturnNameEnum, and an enumeration of IDs, in ReturnIdEnum, representing one or more cluster network interfaces installed on the specified node. Each element of ReturnIdEnum that sets dwType to CLUSTER_NODE_ENUM_NETINTERFACES contains the ID of the cluster network interface as if the CLUSCTL_NETINTERFACE_GET_ID control code is sent to the cluster network interface represented by the name in the corresponding element of the ReturnNameEnum.</td>
 </tr><tr>
  <td>CLUSTER_NODE_ENUM_GROUPS 0x00000002</td>
  <td>The server MUST return an enumeration of names, in ReturnNameEnum, and an enumeration of IDs, in ReturnIdEnum, representing one or more cluster groups currently owned by the specified node. Each element of ReturnIdEnum that sets dwType to CLUSTER_NODE_ENUM_GROUPS contains the ID of the cluster group as if the CLUSCTL_GROUP_GET_ID control code is sent to the cluster group represented by the name in the corresponding element of the ReturnNameEnum.</td>
 </tr></tbody></table>
</dd></dl><p><b>dwOptions: </b>A 32-bit integer that specifies the
options on the type of elements to return. The client MUST set this value to
0x00000000. The server MUST fail the call if this parameter is not set to
0x00000000.</p><p><b>ReturnIdEnum: </b>A pointer to an ENUM_LIST (section 2.2.3.5)
that contains IDs of the objects that match the enumeration type that is
indicated by the <i>dwType</i> parameter. The server MUST allocate as much
memory as is required to return the enumeration data. If the method fails, this
parameter MUST be ignored.</p><p><b>ReturnNameEnum: </b>A pointer to an
ENUM_LIST (section 2.2.3.5) that contains the names of the objects
that match the enumeration type that is indicated by the <i>dwType</i>
parameter. The server MUST allocate as much memory as is required to return the
enumeration data. If the method fails, this parameter MUST be ignored.</p><p><b>rpc_status: </b>A 32-bit integer used to indicate
success or failure. The <span><a href="694e5e7a-5833-4f3d-b47e-323ee1d452c2#gt_8a7f6700-8311-45bc-af10-82e10accd331" data-linktype="relative-path">RPC</a></span> runtime MUST
indicate, by writing to this parameter, whether the runtime succeeded in
executing this method on the server. The encoding of the value passed in this
parameter MUST conform to encoding for comm_status and fault_status, as
specified in Appendix E of <span><a href="https://go.microsoft.com/fwlink/?LinkId=89824" data-linktype="external">[C706]</a></span>.</p><p><b>Return Values: </b>The method MUST return the
following error codes for the specified conditions.</p><dl>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Return value/code</p>
   </th>
   <th>
   <p>Description</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>0x00000000 ERROR_SUCCESS</td>
  <td>Success.</td>
 </tr><tr>
  <td>0x000000057 ERROR_INVALID_PARAMETER</td>
  <td>The dwType parameter is not one of the specified values, or the dwOptions parameter is not 0x00000000.</td>
 </tr><tr>
  <td>0x000006D1 RPC_S_PROCNUM_OUT_OF_RANGE</td>
  <td>The server does not support this method.</td>
 </tr></tbody></table>
</dd></dl><p>For any other condition, this method returns a value that is
not one of the values listed in the preceding table. The client MUST behave in
one consistent, identical manner for all values that are not listed in the
preceding table. The client SHOULD treat errors specified in <span><a href="ca75805a-4b39-4074-8b5b-dbaae6e81b1f" data-linktype="relative-path">3.2.4.6</a></span>
as recoverable errors and initiate the reconnect procedure as specified in
section 3.2.4.6.</p></div>