ChangeNtmsMediaType function (ntmsapi.h)

  • Article

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

The ChangeNtmsMediaType function moves the specified PMID to the specified target media pool and sets the PMID's media type identifier to the media type of the target media pool.

Syntax

DWORD ChangeNtmsMediaType(
  [in] HANDLE      hSession,
  [in] LPNTMS_GUID lpMediaId,
  [in] LPNTMS_GUID lpPoolId
);

Parameters

[in] hSession

Handle to the session returned by the OpenNtmsSession function.

[in] lpMediaId

Unique identifier of the physical media to be moved.

[in] lpPoolId

Unique identifier of the media pool from which the media is to be allocated.

Return value

This function returns one of the following values.

Value Meaning
ERROR_ACCESS_DENIED
 NTMS_MODIFY_ACCESS to the computer or the media's media pool is denied. Other security errors are possible, but they would indicate a security subsystem error.

Windows XP:   NTMS_MODIFY_ACCESS to the 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 missing or is not valid.
ERROR_INVALID_MEDIA_POOL
 The media pool ID is not valid.
ERROR_INVALID_PARAMETER
 The media pool or media ID is missing.
ERROR_NOT_ENOUGH_MEMORY
 An allocation failure occurred during processing.
ERROR_SUCCESS
 The function was successful.

Remarks

The ChangeNtmsMediaType function uses the same policy for moving media as the MoveToNtmsMediaPool function (unrecognized media can only be moved to the free pool).

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

See also

AddNtmsMediaType

DeleteNtmsMediaType

Media Services Functions