DeallocateNtmsMedia

[This is preliminary documentation and subject to change.]

The DeallocateNtmsMedia function deallocates the partition associated with the specified logical media.

DWORD WINAPI DeallocateNtmsMedia(
  HANDLE hSession, 
  LPNTMS_GUID lpMediaId,
  DWORD dwOptions
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpMediaId

Specifies the unique identifier of logical media.

dwOptions

Reserved; must be zero.

Return Values

ERROR_ACCESS_DENIED

NTMS_MODIFY_ACCESS to 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 invalid or missing.

ERROR_INVALID_MEDIA

The LMID is invalid.

ERROR_INVALID_PARAMETER

The media or media pool ID is missing.

ERROR_INVALID_PARTITION

The LMID partition is invalid.

ERROR_NOT_ENOUGH_MEMORY

An allocation failure occurred during processing.

ERROR_SUCCESS

The function was successful.

Remarks

When a logical medium is deallocated with the DeallocateNtmsMedia function, RSM puts the partition associated with the logical media in the Available or Decommissioned media state. The logical media is deleted from the system when the logical media is deallocated.

Partitions are decommissioned upon deallocation if the partition has been allocated the maximum number of times specified in the media pool. After media is in the Decommissioned state, it cannot be allocated again.

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, AllocateNtmsMedia