Platform SDK: Removable Storage Manager

DeleteNtmsMedia

The DeleteNtmsMedia function deletes a physical piece of offline media from RSM by removing all references to the specified media from the database.

DWORD WINAPI DeleteNtmsMedia(
  HANDLE hSession,
  LPNTMS_GUID lpMediaId
);

Parameters

hSession
Handle to the session returned by the OpenNtmsSession function.
lpMediaId
Specifies the unique identifier 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 the media is invalid.
ERROR_INVALID_PARAMETER The media identifier is missing.
ERROR_INVALID_STATE The media is not offline.
ERROR_NOT_ENOUGH_MEMORY An allocation failure occurred during processing.
ERROR_SUCCESS The function was successful.

Remarks

Media specified by the DeleteNtmsMedia function must be located in an offline library and not have a side in the Allocated, Completed, or Reserved states.

You can use DeleteNtmsMedia to remove lost or destroyed media.

Requirements

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

See Also

Media Services Functions