Share via

3.1.4.1.103 ApiCreateResTypeEnum (Opnum 103)

  • Article

(Protocol Version 2) The ApiCreateResTypeEnum method returns a collection of named objects in the cluster state associated with the designated resource type.

The server SHOULD<69> accept an ApiCreateResTypeEnum request if its protocol server state is read-only, and the server MUST accept the request for processing if it is in the read/write state, as specified in section 3.1.1.

 error_status_t ApiCreateResTypeEnum(
   [in, string] LPCWSTR lpszTypeName,
   [in] DWORD dwType,
   [out] PENUM_LIST *ReturnEnum
 );

lpszTypeName: A pointer to a null-terminated Unicode string buffer containing the name of the resource type.

dwType: The type of enumeration to be returned by the server. The client MUST set dwType to the bitwise OR operator of one or more of the following values.

Value

Meaning

CLUSTER_RESOURCE_TYPE_ENUM_NODES

0x00000001

Returns an enumeration of zero or more node names where the server implementation-specific object that codifies the resource's functionality is present, hence for which a resource of the type specified by lpszTypeName can be created or hosted.

ReturnEnum: A pointer to an ENUM_LIST structure, as specified in section 2.2.3.5, that contains the data that matches the enumeration type that is indicated by the dwType 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.

If the client sets dwType to a value other than as specified above, the server SHOULD ignore all bits in dwType except those that match the bit(s) in allowable dwType values and complete the method successfully, provided no other failure conditions are met.

Return Values: The method MUST return the following error codes for the specified conditions.

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.

0x000013D6

ERROR_CLUSTER_RESOURCE_TYPE_NOT_FOUND

The resource type specified by the lpszTypeName parameter is not part of the nonvolatile cluster state.

For any other condition, the server MUST set Status to a value that is not one of the values listed in the preceding table. The client MUST treat all values that are not listed in the preceding table the same, except as specified in section 3.2.4.6.