3.2.4.25 CprepDiskIsOnline (Opnum 34)

  • Article

The CprepDiskIsOnline method reports whether the ClusPrepDisk, identified by the DiskId parameter, has ClusPrepDisk.OnlineState equal to Online.

 HRESULT CprepDiskIsOnline(
   [in] CPREP_DISKID DiskId
 );

DiskId: The identifier representing the ClusPrepDisk.

Return Values:  A signed 32-bit value that indicates return status. If the method returns a negative value, it has failed. Zero or positive values indicate success, with the lower 16 bits in positive nonzero values containing warnings or flags defined in the method implementation. For more information about Win32 error codes and HRESULT values, see [MS-ERREF] sections 2.2 and 2.1.

Return value/code

Description

0x00000000

S_OK

The call was successful and ClusPrepDisk.OnlineState is equal to Online.

0x80070015

ERROR_NOT_READY

ClusPrepDisk.OnlineState is not equal to Online.

0x80070548

ERROR_INVALID_SERVER_STATE

The server's Prepare State is not Online.

For any other condition, this method MUST return 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.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].

The opnum field value for this method is 34.

When processing this call, the server MUST do the following:

  • Obtain the ClusPrepDisk identified by the DiskId parameter as specified in section 3.2.4.

  • Return S_OK if the ClusPrepDisk.OnlineState is Online or ERROR_NOT_READY if the ClusPrepDisk.OnlineState is Not Online state.