DeleteNtmsLibrary

[This is preliminary documentation and subject to change.]

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.

DWORD WINAPI DeleteNtmsLibrary(
  HANDLE hSession, 
  LPNTMS_GUID lpLibraryId
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpLibraryId

Specifies the unique identifier of a library.

Return Values

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

There is an invalid or missing session handle.

ERROR_INVALID_LIBRARY

There is an invalid library identifier.

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.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in ntmsapi.h.
  Import Library: Use ntmsapi.lib.

See Also

Library Control Functions