3.2.4.4.1.7 IVolumeClient::WriteSignature (Opnum 9)

  • Article

The WriteSignature method writes a disk signature to a specified disk. This is a synchronous task.

 HRESULT WriteSignature(
   [in] LdmObjectId diskId,
   [in] hyper diskLastKnownState,
   [out] TASK_INFO* tinfo
 );

diskId: Specifies the object identifier of the target disk for the signature.

diskLastKnownState: Disk's last known modification sequence number.

tinfo: Pointer to a TASK_INFO structure that the client can use to track the request's progress.

Return Values: The method MUST return 0 or a nonerror HRESULT on success, or an implementation-specific nonzero error code on failure (as specified in [MS-ERREF] section 2.1; see also section 2.2.1 for HRESULT values predefined by the Disk Management Remote Protocol).

Upon receiving this message, the server MUST validate parameters:

  1. Verify that the disk specified by diskId is in the list of storage objects, and check if diskLastKnownState matches the LastKnownState field of the object.

  2. Verify that tinfo is not NULL.

If parameter validation fails, the server MUST fail the operation immediately, returning an appropriate error as its response to the client.

Otherwise, the server MUST process the message as follows:

  1. Write an MBR signature, and initialize the partition table of the disk.

  2. Wait for the signature writing to either succeed or fail.

  3. Fill in the tinfo output parameter.

    TASK_INFO member

    Required for this operation

    TASK_INFO::id

    Required.

    TASK_INFO::storageId

    Not required.

    TASK_INFO::createTime

    Not required.<36>

    TASK_INFO::clientID

    Not required.<37>

    TASK_INFO::percentComplete

    Required for any task that returns REQ_IN_PROGRESS.

    TASK_INFO::status

    Required.

    TASK_INFO::type

    Required if PercentageComplete is being used.

    TASK_INFO::error

    Required.

    TASK_INFO::tflag

    Not required.<38>

  4. Return a response to the client that contains tinfo and the status of the operation.

If the operation is successful, the server MUST make the following change to the list of storage objects before returning the response:

  • Modify the disk object to account for the change of status.