Compartilhar via


DecommissionNtmsMedia Function

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

The DecommissionNtmsMedia function moves a side from the Available state to the Decommissioned state.

Syntax

DWORD DecommissionNtmsMedia(
  __in  HANDLE hSession,
  __in  LPNTMS_GUID lpMedia
);

Parameters

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

  • lpMedia [in]
    Unique identifier of a side of a piece of physical media.

Return Value

Value Meaning
ERROR_ACCESS_DENIED

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

Windows XP/2000:  NTMS_MODIFY_ACCESS to the 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 missing or is not valid.

ERROR_INVALID_MEDIA

The media identifier is not valid.

ERROR_INVALID_MEDIA_POOL

The media pool for media is not valid.

ERROR_INVALID_PARAMETER

The media identifier is missing.

ERROR_INVALID_STATE

The media is not in the Available state.

ERROR_NOT_ENOUGH_MEMORY

An allocation failure occurred during processing.

ERROR_SUCCESS

The function was successful.

 

Remarks

Media decommissioned by the DecommissionNtmsMedia function is recognized by RSM but the decommissioned media does not contain any data and is never again used.

Only media that is in the Available state can be decommissioned. For more information, see Media Life Cycle.

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

AllocateNtmsMedia

 

 

Send comments about this topic to Microsoft

Build date: 6/9/2011