Share via

CeSetDatabaseInfo

  • Article

This function sets various database parameters, including the name, type, and sort-order descriptions. This function is obsolete. Applications should call CeSetDatabaseInfoEx instead.

A RAPI version of this function exists called CeSetDatabaseInfoEx (RAPI).

BOOL CeSetDatabaseInfo(
  CEOID oidDbase, 
  CEDBASEINFO* pNewInfo
);

Parameters

  • oidDbase
    [in] Object identifier of the database for which parameters are to be set.
  • pNewInfo
    [in] Pointer to a CEDBASEINFO structure that contains new parameter information for the database. The wNumRecords member of the structure is not used.

Return Values

TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError. The following table lists possible values for GetLastError.

Value Description
ERROR_INVALID_PARAMETER Indicates that a parameter was invalid.
ERROR_DISK_FULL Indicates that the object store is full and any size changes required could not be accommodated. Changing sort orders may change the size of the stored records, but only by a small amount.
ERROR_SHARING_VIOLATION Indicates that CeSetDatabaseInfo tried to remove a sort order that is being used by a currently open database.

Remarks

The CeSetDatabaseInfo function can be used to change the database parameters passed in while creating the database. Note that changing the sort order of the database can take several minutes. Before calling CeSetDatabaseInfo, an application should warn the user that this operation can be lengthy.

For Windows CE 2.10 through 2.12, do not call this function on an open database. For Windows CE 3.0 and later, the sort orders of a database cannot be changed while a handle to that database remains open.

Requirements

OS Versions: Windows CE 1.01 and later.
Header: Windbase.h.
Link Library: Coredll.lib.

See Also

CeCreateDatabase | CeOidGetInfo | CEDBASEINFO | CeSetDatabaseInfoEx2

 Last updated on Friday, April 09, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.