Last modified: January 09, 2012
Applies to: Windows | Windows Server
Windows XP: JetCloseFileInstance is introduced in Windows XP.
JET_ERR JET_API JetCloseFileInstance( __in JET_INSTANCE instance, __in JET_HANDLE hfFile );
The instance to use for this call.
For Windows 2000, the API variant that accepts this parameter is not available because only one instance is supported. The use of this one global instance is implied in this case.
For Windows XP and later releases, the API variant that does not accept this parameter may only be called when the engine is in legacy mode (Windows 2000 compatibility mode) where only one instance is supported. Otherwise, the operation will fail with JET_errRunningInMultiInstanceMode.
The handle of the file to be read.
This function returns the JET_ERR datatype with one of the following return codes. For more information about the possible ESE errors, see Extensible Storage Engine Errors and Error Handling Parameters.
The operation completed successfully.
It is not possible to complete the operation because all activity on the instance associated with the session has ceased as a result of a call to JetStopServiceInstance.
It is not possible to complete the operation because the instance associated with the session has encountered a fatal error that requires that access to all data be revoked to protect the integrity of that data.
This error will only be returned by Windows XP and later releases.
One of the parameters that was provided contained an unexpected value, or the combination of several parameter values yielded an unexpected result. This can happen for JetCloseFileInstance when:
The operation failed because no external backup is in progress.
It is not possible to complete the operation because the instance associated with the session has not been initialized yet.
It is not possible to complete the operation because a restore operation is in progress on the instance associated with the session.
The operation failed because an attempt was made to use the engine in legacy mode (Windows 2000 compatibility mode) where only one instance is supported when in fact multiple instances already exist.
It is not possible to complete the operation because the instance associated with the session is being shut down.
On success, the file handle is closed. If a database file was closed then the associated database patch file (if any) is destroyed.
On failure, no change occurs.
The database engine currently only supports one open file through JetOpenFileInstance at a time. If a file handle is opened using JetOpenFileInstance then it must be closed using JetCloseFileInstance before another file can be opened.
Requires Windows Vista or Windows XP.
Requires Windows Server 2008 or Windows Server 2003.
Declared in Esent.h.