nf-ntmsapi-decommissionntmsmedia.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:ntmsapi.DecommissionNtmsMedia	DecommissionNtmsMedia function (ntmsapi.h)	The DecommissionNtmsMedia function moves a side from the Available state to the Decommissioned state.	DecommissionNtmsMedia DecommissionNtmsMedia function [Files] _zaw_decommissionntmsmedia base.decommissionntmsmedia fs.decommissionntmsmedia ntmsapi/DecommissionNtmsMedia	fs\decommissionntmsmedia.htm	fs	2bb1a54b-6308-4ccd-9fc6-1b11f4432a3f	12/05/2018	DecommissionNtmsMedia, DecommissionNtmsMedia function [Files], _zaw_decommissionntmsmedia, base.decommissionntmsmedia, fs.decommissionntmsmedia, ntmsapi/DecommissionNtmsMedia	ntmsapi.h		Windows	Windows XP [desktop apps only]	Windows Server 2003 [desktop apps only]										Ntmsapi.lib	Ntmsapi.dll		Windows			19H1	DecommissionNtmsMedia ntmsapi/DecommissionNtmsMedia	c++	APIRef kbSyntax	DllExport	Ntmsapi.dll	DecommissionNtmsMedia

DecommissionNtmsMedia function

-description

[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.

-parameters

-param hSession [in]

Handle to the session returned by the OpenNtmsSession function.

-param lpMediaId [in]

Unique identifier of a side of a piece of physical media.

-returns

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:  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.

-see-also

AllocateNtmsMedia

Media Services Functions