Share via

3.1.4.1.5 ApiGetClusterVersion (Opnum 4)

  • Article

(Protocol Version 2) The ApiGetClusterVersion method retrieves version information about the cluster and the server that the client is connected to.

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

For successful completion of this method, servers MUST set the parameters that are specified as follows.

 error_status_t ApiGetClusterVersion(
   [out] WORD* lpwMajorVersion,
   [out] WORD* lpwMinorVersion,
   [out] WORD* lpwBuildNumber,
   [out, string] LPWSTR* lpszVendorId,
   [out, string] LPWSTR* lpszCSDVersion
 );

lpwMajorVersion: Identifies the major version number of the protocol server software, as specified in section 3.1.4.1.102.

lpwMinorVersion: Identifies the minor version number of the protocol server software, as specified in section 3.1.4.1.102.

lpwBuildNumber: Identifies the build number of the protocol server software, as specified in section 3.1.4.1.102.

lpszVendorId: Identifies the vendor product ID name of the protocol server software, as specified in section 3.1.4.1.102.

lpszCSDVersion: Identifies the latest operating system service pack that is installed on the server, as specified in section 3.1.4.1.102.

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

For any other condition, the server MUST return a value that is not one of the values listed in the following table. The client MUST behave in one consistent, identical manner for all values that are not listed except as specified in section 3.2.4.6.

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.