DeleteNtmsMedia function (ntmsapi.h)

Article
10/13/2021

[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]

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

Syntax

DWORD DeleteNtmsMedia(
  [in] HANDLE      hSession,
  [in] LPNTMS_GUID lpMediaId
);

Parameters

[in] hSession

Handle to the session returned by the OpenNtmsSession function.

[in] lpMediaId

Unique identifier of a piece of physical media.

Return value

This function returns one of the following values.

Value	Meaning
ERROR_ACCESS_DENIED	NTMS_MODIFY_ACCESS to the computer or the media's media pool is denied. Other security errors are also possible, but they would indicate a security subsystem error. Windows XP: NTMS_MODIFY_ACCESS to the 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 missing or is not valid.
ERROR_INVALID_MEDIA	The media identifier is not valid.
ERROR_INVALID_MEDIA_POOL	The media pool for the media is not valid.
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

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	ntmsapi.h
Library	Ntmsapi.lib
DLL	Ntmsapi.dll