DeleteNtmsMediaPool Function
[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]
The DeleteNtmsMediaPool function deletes the specified application media pool.
Syntax
DWORD DeleteNtmsMediaPool(
__in HANDLE hSession,
__in LPNTMS_GUID lpPoolId
);
Parameters
hSession [in]
Handle to the session returned by the OpenNtmsSession function.lpPoolId [in]
Unique identifier of the media pool.
Return Value
This function returns one of the following values.
| Value | Meaning |
|---|---|
| ERROR_ACCESS_DENIED | NTMS_MODIFY_ACCESS to the media pool is denied. Other security errors are also possible, but they indicate a security subsystem error.
|
| ERROR_DATABASE_FAILURE | The database is inaccessible or damaged. |
| ERROR_INVALID_HANDLE | The session handle is missing or is not valid. |
| ERROR_INVALID_MEDIA_POOL | Unable to open existing media pool, or attempting to delete free, import, or unrecognized media pools. |
| ERROR_INVALID_PARAMETER | The media pool ID is missing. |
| ERROR_NOT_EMPTY | The media pool must be empty to be deleted. |
| ERROR_NOT_ENOUGH_MEMORY | An allocation failure occurred during processing. |
| ERROR_SUCCESS | The function was successful. |
Remarks
Only empty media pools can be deleted with the DeleteNtmsMediaPool function.
Free, unrecognized, and import media pools are managed by RSM and cannot be deleted with DeleteNtmsMediaPool.
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
Send comments about this topic to Microsoft
Build date: 6/9/2011