SwapNtmsMedia function (ntmsapi.h)

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

The SwapNtmsMedia function swaps the sides associated with the two specified LMIDs. The specified LMIDs must be in the same media pool.

Syntax

DWORD SwapNtmsMedia(
  [in] HANDLE      hSession,
  [in] LPNTMS_GUID lpMediaId1,
  [in] LPNTMS_GUID lpMediaId2
);

[in] hSession

Handle to the session returned by the OpenNtmsSession function.

[in] lpMediaId1

Unique identifier of a piece of logical media (LMID).

[in] lpMediaId2

Unique identifier of a piece of logical media (LMID).

This function returns one of the following values.

Value	Meaning
ERROR_ACCESS_DENIED	NTMS_MODIFY_ACCESS to either media's media pool is denied. Other security errors are also possible, but they would indicate a security subsystem error.
ERROR_BAD_FORMAT	No media label library recognizes the media label.
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	At least one of the media IDs is not valid.
ERROR_INVALID_MEDIA_POOL	One or more media pools for the logical media are not valid.
ERROR_INVALID_PARAMETER	At least one media identifier is missing.
ERROR_NOT_ENOUGH_MEMORY	An allocation failure occurred during processing.
ERROR_SUCCESS	The function was successful.

The SwapNtmsMedia function is used to update physical media without affecting the application.

The media for both LMIDs must not be in use for this function to succeed.

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

Was this page helpful?