Last modified: January 09, 2012
Applies to: Windows | Windows Server
The JetRenameTable function can be used to change the name of an existing table.
JET_ERR JET_API JetRenameTable( __in JET_SESID sesid, __in JET_DBID dbid, __in const tchar* szName, __in const tchar* szNameNew );
The session to use for this call.
The database to use for this call.
The current name of the table that will be renamed.
The new name for the table that will be renamed.
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 JetStopService.
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.
The specified database was invalid.
This error is only returned in Windows 2000 when a table rename operation is attempted on the temporary database. JET_errInvalidDatabaseId is returned for this case in later releases.
The specified database ID was invalid.
One of the specified object names was invalid. All object names must conform to the same set of rules. These rules are as follows:
One of the parameters provided contained an unexpected value or contained a value that did not make sense when combined with the value of another parameter. This can happen for JetRenameTable when:
It is not possible to complete the operation because the instance associated with the session has not been initialized yet.
This specified table does not exist for this database.
It is not possible to complete the operation because a restore operation is in progress on the instance associated with the session.
The same session cannot be used for more than one thread at the same time. This error will only be returned by Windows XP and later releases.
It is not possible to complete the operation because the instance associated with the session is being shut down.
An update cannot be done while inside the scope of a read-only transaction. A read-only transaction is a transaction that has been started using a call to JetBeginTransaction2 with JET_bitTransactionReadOnly.
This error will only be returned by Windows XP and later releases.
On success, the name of the specified table in the given database is permanently changed to the new name.
On failure, no change to the database state will occur.
Requires Windows Vista, Windows XP, or Windows 2000 Professional.
Requires Windows Server 2008, Windows Server 2003, or Windows 2000 Server.
Declared in Esent.h.
Implemented as JetRenameTableW (Unicode) and JetRenameTableA (ANSI).