Platform SDK: Removable Storage Manager

SetNtmsMediaComplete

The SetNtmsMediaComplete function marks a piece of logical media as complete.

DWORD WINAPI SetNtmsMediaComplete(
  HANDLE hSession, 
  LPNTMS_GUID lpMediaId
);

Parameters

hSession
Handle to the session returned by the OpenNtmsSession function.
lpMediaId
Specifies the unique identifier of a piece of logical media.

Return 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_DATABASE_FAILURE The database is inaccessible or damaged.
ERROR_DATABASE_FULL The database is full.
ERROR_INVALID_HANDLE The session handle is invalid or missing.
ERROR_INVALID_MEDIA The media identifier is invalid.
ERROR_INVALID_MEDIA_POOL The media pool for the media is invalid.
ERROR_INVALID_PARAMETER The media identifier is missing.
ERROR_INVALID_STATE The media is not in the allocated state or is currently mounted.
ERROR_NOT_ENOUGH_MEMORY An allocation failure occurred during processing.
ERROR_SUCCESS 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

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Ntmsapi.h.
  Library: Use Ntmsapi.lib.

See Also

Media Services Functions, MountNtmsMedia