ChangeNtmsMediaType Function

[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 Pmid,
  __in  LPNTMS_GUID MPoolId
);

Parameters

  • hSession [in]
    Handle to the session returned by the OpenNtmsSession function.

  • Pmid [in]
    Unique identifier of the physical media to be moved.

  • MPoolId [in]
    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/2000:   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

Minimum supported client

Windows 2000 Professional

Minimum supported server

Windows 2000 Server

End of client support

Windows Vista

End of server support

Windows Server 2008

Header

Ntmsapi.h

Library

Ntmsapi.lib

DLL

Ntmsapi.dll

See Also

Media Services Functions

AddNtmsMediaType

DeleteNtmsMediaType

 

 

Send comments about this topic to Microsoft

Build date: 6/9/2011