DeleteNtmsMediaPool

[This is preliminary documentation and subject to change.]

The DeleteNtmsMediaPool function deletes the specified application media pool.

DWORD WINAPI DeleteNtmsMediaPool(
  HANDLE hSession, 
  LPNTMS_GUID lpPoolId
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpPoolId

Specifies the unique identifier of the media pool.

Return Values

ERROR_ACCESS_DENIED

NTMS_CONTROL_ACCESS to the media pool is denied. Other security errors are also possible, but they indicate a security subsystem error.

ERROR_DATABASE_FAILURE

The database is inaccessible or damaged.

ERROR_INVALID_HANDLE

The session handle is invalid or missing.

ERROR_INVALID_MEDIA_POOL

Unable to open existing media pool, or attempting to delete scratch, import, or foreign media pools.

ERROR_INVALID_PARAMETER

The media pool ID is missing.

ERROR_NOT_EMPTY

The media pool must be empty to be deleted.

ERROR_NOT_ENOUGH_MEMORY

An allocation failure occurred during processing.

ERROR_SUCCESS

The function was successful.

Remarks

Only empty media pools can be deleted with the DeleteNtmsMediaPool function.

Scratch, foreign, and import media pools are managed by RSM and cannot be deleted with DeleteNtmsMediaPool.

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, CreateNtmsMediaPool, MoveToNtmsMediaPool