ExportNtmsDatabase Function

[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

hSession [in]

Handle to the session returned by the OpenNtmsSession function.

Return Value

This function returns one of the following values.

ValueMeaning
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

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

Database Backup and Recovery Functions
ImportNtmsDatabase

 

 

Send comments about this topic to Microsoft

Build date: 6/9/2011

Show: