Platform SDK: Removable Storage Manager

DecommissionNtmsMedia

The DecommissionNtmsMedia function moves a side from the Available state to the Decommissioned state.

DWORD WINAPI DecommissionNtmsMedia(
   HANDLE hSession, 
  LPNTMS_GUID lpMedia
);

Parameters

hSession: Handle to the session returned by the OpenNtmsSession function.
lpMedia: Specifies the unique identifier of a side of a piece of physical media.

Return Values

Value	Meaning
ERROR_ACCESS_DENIED	NTMS_MODIFY_ACCESS to either media's media pool 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_INVALID_HANDLE	The session handle is invalid or missing.
ERROR_INVALID_MEDIA	The media identifier is invalid.
ERROR_INVALID_MEDIA_POOL	The media pool for media is invalid.
ERROR_INVALID_PARAMETER	The media identifier is missing.
ERROR_INVALID_STATE	The media is not in the Available state.
ERROR_NOT_ENOUGH_MEMORY	An allocation failure occurred during processing.
ERROR_SUCCESS	The function was successful.

Remarks

Media decommissioned by the DecommissionNtmsMedia function is recognized by RSM but the decommissioned media does not contain any data and is never again used.

Only media that is in the Available state can be decommissioned.

Requirements

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

DecommissionNtmsMedia

Parameters

Return Values

Remarks

Requirements

See Also