ExportNtmsDatabase function (ntmsapi.h)

Article
02/22/2024

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

The ExportNtmsDatabase function creates a consistent set of database files in the RSM database directory.

Syntax

DWORD ExportNtmsDatabase(
  [in] HANDLE hSession
);

Parameters

[in] hSession

Handle to the session returned by the OpenNtmsSession function.

Return value

This function returns one of the following values.

Value	Meaning
ERROR_ACCESS_DENIED	Access to one or more RSM objects is denied.
ERROR_DATABASE_FAILURE	The database query or update failed.
ERROR_INVALID_HANDLE	The value specified in the hSession parameter is not valid.
ERROR_NOT_CONNECTED	Unable to connect to the RSM service.
ERROR_SHARING_VIOLATION	One of the files that the function must write to is open.
ERROR_SUCCESS	The function was successful.

Remarks

The ExportNtmsDatabase function is used by backup applications to create a copy of the RSM database. Any existing files in the Export directory are overwritten by this function.

The default location of the database is%SystemRoot%\System32\NtmsData, but this can be set by defining a registry value:

HKLM\System\CurrentControlSet\Control\NTMS\NtmsData

This function creates a subdirectory called Export and places the consistent files there.

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