3.2.4.5 CprepDiskGetProps (Opnum 7)

The CprepDiskGetProps method retrieves information about the configuration and status of a given disk.

 HRESULT CprepDiskGetProps(
   [in] CPREP_DISKID DiskId,
   [out] DISK_PROPS* DiskProps
 );

DiskId: The identifier of the ClusPrepDisk for which to get the disk properties.

DiskProps: The properties of the selected 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.

0x80070002

ERROR_FILE_NOT_FOUND

The disk was not found.

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 7.

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.

  • Gather the information about the given disk.

  • Populate a valid DISK_PROPS structure with the information.

The server returns the following information to the client:

  • The properties of the selected disk.