DeleteNtmsLibrary function (ntmsapi.h)

Article
02/22/2024

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

The DeleteNtmsLibrary function deletes a library, and all the devices contained in the library, from the RSM database. All media in the library is moved to the offline library.

Syntax

DWORD DeleteNtmsLibrary(
  [in] HANDLE      hSession,
  [in] LPNTMS_GUID lpLibraryId
);

Parameters

[in] hSession

Handle to the session returned by the OpenNtmsSession function.

[in] lpLibraryId

Unique identifier of the library to be deleted.

Return value

This function returns one of the following values.

Value	Meaning
ERROR_ACCESS_DENIED	NTMS_MODIFY_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_INVALID_HANDLE	The session handle is missing or is not valid.
ERROR_INVALID_LIBRARY	The library identifier is not valid.
ERROR_INVALID_PARAMETER	There is a missing media identifier.
ERROR_NOT_ENOUGH_MEMORY	There was an allocation failure during processing.
ERROR_SUCCESS	The function was successful.

Remarks

If the library referenced by the DeleteNtmsLibrary function contains media, the media is moved to the offline library.

You can use DeleteNtmsLibrary to remove libraries that are no longer connected to the RSM server.

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