DeleteNtmsMediaType

[This is preliminary documentation and subject to change.]

The DeleteNtmsMediaType function deletes the specified media type relation from the specified library provided that the library does not contain any physical media objects of the specified media type (offline included).

DWORD DeleteNtmsMediaType(
  HANDLE hSession,
  LPNTMS_GUID lpMediaTypeId,
  LPNTMS_GUID lpLibId
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpMediaTypeId

Specifies the unique identifier of a media type to delete from a library.

lpLibId

Specifies the unique identifier of the library from which to delete the media type.

Return Values

ERROR_ACCESS_DENIED

NTMS_MODIFY_ACCESS to media's media pool is denied.

ERROR_DATABASE_FAILURE

The database is inaccessible or damaged.

ERROR_DATABASE_FULL

The database is full.

ERROR_INVALID_HANDLE

The session handle is bad or missing.

ERROR_INVALID_LIBRARY

The library ID is invalid.

ERROR_INVALID_PARAMETER

The media type or library ID is missing.

ERROR_NOT_ENOUGH_MEMORY

An allocation failure occurred during processing.

ERROR_SUCCESS

The function was successful.

Remarks

If there are no physical media objects of the specified media type in the RSM system and there are no library objects that contain the specified media type relation in the RSM system, the system media pools for that media type will be deleted. Inability to delete the system media pools does not cause the DeleteNtmsMediaType function to fail. This call requires the caller to have NTMS_CONTROL_ACCESS rights to the library object.

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

Media Services Functions, AddNtmsMediaType