Platform SDK: Removable Storage Manager

DismountNtmsDrive

The DismountNtmsDrive function queues a command to move the media in the specified drive to its storage slot. This function should be paired with the MountNtmsMedia function.

DWORD WINAPI DismountNtmsDrive(
  HANDLE hSession, 
  LPNTMS_GUID lpDriveId
);

Parameters

hSession
Handle to the session returned by the OpenNtmsSession function.
lpDriveId
Specifies the unique identifier of a drive object.

Return Values

Value Meaning
ERROR_ACCESS_DENIED NTMS_CONTROL_ACCESS to the library is denied. Other security errors are also possible, but they would indicate a security subsystem error.
ERROR_DATABASE_FAILURE The database is inaccessible or damaged.
ERROR_DATABASE_FULL The database is full.
ERROR_DEVICE_NOT_AVAILABLE The drive or library is not enabled.
ERROR_INVALID_DRIVE There is an invalid drive ID.
ERROR_INVALID_HANDLE There is an invalid or missing session handle.
ERROR_INVALID_LIBRARY There is an invalid library for the drive.
ERROR_INVALID_PARAMETER There is a missing drive ID.
ERROR_INVALID_STATE The drive does not contain media.
ERROR_NOT_ENOUGH_MEMORY An allocation failure occurred during processing.
ERROR_SUCCESS The function was successful.

Remarks

If the drive specified by the DismountNtmsDrive function is empty or if the media is opened, an error is returned. Otherwise, the media is returned to its slot.

Dismount requests to stand alone drives place the drive in the dismountable state and return success.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Ntmsapi.h.
  Library: Use Ntmsapi.lib.

See Also

Library Control Functions