Share via

3.2.4.4.1.9 IVolumeClient::Eject (Opnum 11)

  • Article

The Eject method ejects a specified removable disk or CD-ROM from the drive enclosure. This is a synchronous task.

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

diskId: Specifies the OID of the media to eject.

diskLastKnownState: The 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 whether 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. Eject the media from the drive specified by diskId.

  2. Wait for the eject to 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.<42>

    TASK_INFO::clientID

    Not required.<43>

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

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

If the operation is successful, the server makes the following changes to the list of storage objects before returning the response:

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

  2. Delete the disk region object that resides on the disk.

  3. Modify the drive letter object that corresponds to the disk region to point to the disk object instead of the disk region object.