SetNtmsMediaComplete function (ntmsapi.h)
[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]
The SetNtmsMediaComplete function marks a piece of logical media as complete.
Syntax
DWORD SetNtmsMediaComplete(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpMediaId
);
Parameters
[in] hSession
Handle to the session returned by the OpenNtmsSession function.
[in] lpMediaId
Unique identifier of a piece of logical media.
Return value
This function returns one of the following values.
Value | Meaning |
---|---|
|
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. |
|
The database is inaccessible or damaged. |
|
The database is full. |
|
The session handle is missing or is not valid. |
|
The media identifier is not valid. |
|
The media pool for the media is not valid. |
|
The media identifier is missing. |
|
The media is not in the allocated state or is currently mounted. |
|
An allocation failure occurred during processing. |
|
The function was successful. |
Remarks
The SetNtmsMediaComplete function marks the specified medium as Complete. An application marks the medium as Complete when the application is no longer going to write to the medium. Complete media cannot be mounted with the NTMS_MOUNT_WRITE flag.
The SetNtmsMediaComplete function is typically used when an application reaches the end of media. Media that is mounted or in use cannot be marked as complete.
Requirements
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 |