Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
3.1.4.2.102 ApiGetClusterVersion2 (Opnum 102)
Collapse the table of content
Expand the table of content

3.1.4.2.102 ApiGetClusterVersion2 (Opnum 102)

Note: Some of the information in this section is subject to change because it applies to an unreleased, preliminary version of the Windows Server operating system, and thus may differ from the final version of the server software when released. All behavior notes that pertain to the unreleased, preliminary version of the Windows Server operating system contain specific references to Windows Server 2016 Technical Preview in the Product Behavior appendix.

(Protocol Version 3) The ApiGetClusterVersion2 method retrieves version information about the cluster and the server to which the client is connected. Note that the version of the cluster and the version of the server can differ from the version of the ClusAPI Protocol.

The server SHOULD accept an ApiGetClusterVersion2 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.

The server accepts an ApiGetClusterVersion2 request if the client's access level is at least "Read" (section 3.1.4).

 error_status_t ApiGetClusterVersion2(
   [out] WORD* lpwMajorVersion,
   [out] WORD* lpwMinorVersion,
   [out] WORD* lpwBuildNumber,
   [out, string] LPWSTR* lpszVendorId,
   [out, string] LPWSTR* lpszCSDVersion,
   [out] PCLUSTER_OPERATIONAL_VERSION_INFO* ppClusterOpVerInfo,
   [out] error_status_t* rpc_status
 );

lpwMajorVersion: Identifies the major version number of the protocol server software After successful completion of this method a server SHOULD<68> set this parameter to 0x000a. If the method fails, this parameter MUST be ignored.

lpwMinorVersion: Identifies the minor version number of the protocol server software. After successful completion of this method, a server SHOULD<69> set this parameter to 0x0000. If the method fails, this parameter MUST be ignored.

lpwBuildNumber: Identifies the build number of the protocol server software. After successful completion of this method, a server SHOULD<70> set this parameter to 0x2648. If the method fails, this parameter MUST be ignored.

lpszVendorId: Identifies the vendor product ID name of the protocol server software. After successful completion of this method, the server MUST set this parameter either to a null-terminated Unicode string that identifies the vendor product or to an empty Unicode string.<71> The server MUST allocate sufficient memory to store this string, including null-termination. If the method fails, this parameter MUST be ignored.

lpszCSDVersion: Identifies the latest operating system service pack that is installed on the server. After successful completion of this method, the server MUST set this parameter to either a null-terminated Unicode string identifying an operating system service pack that is installed (if any),<72> or a null-terminated Unicode empty string. If the method fails, this parameter MUST be ignored.

ppClusterOpVerInfo: Identifies the operational version of the cluster, as specified in section 2.2.3.3, of which the server is an active node. After successful completion of this method, the server MUST allocate sufficient memory to return a CLUSTER_OPERATIONAL_VERSION_INFO structure and set the ppClusterOpVerInfo to point to the allocated buffer. If the method fails, this parameter MUST be ignored.

rpc_status: A 32-bit integer used to indicate success or failure. The RPC runtime MUST indicate whether or not it succeeded in executing this method on the server by writing to this parameter. 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 [C706].

Return Values: Upon successful completion of this method, the server MUST return 0x00000000 (ERROR_SUCCESS).

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.

For any other condition, the server 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, except as specified in section 3.2.4.6.

Show:
© 2015 Microsoft