Share via

CeSetDatabaseInfoEx

  • Article

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

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

BOOL CeSetDatabaseInfoEx( 
  PCEGUID pceguid, 
  CEOID oidDbase,
  CEDBASEINFO* pNewInfo
);

Parameters

  • pceguid
    [in] Pointer to the CEGUID that contains the globally unique identifier of a mounted database volume or of the object store. Use CREATE_SYSTEMGUID to obtain the GUID of the object store.
  • 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 or mounted volume is full and any size changes required could not be accommodated. Changing sort orders can minimally change the size of the stored records.
ERROR_SHARING_VIOLATION Indicates that the CeSetDatabaseInfoEx function tried to remove a sort order that is being used by a currently open database. For Windows 3.0 and later, this indicates that CeSetDatabaseInfoEx was called on an open database.

Remarks

Use CeSetDatabaseInfoEx to change the database parameters passed in while creating the database. Changing the sort order or compression of a database is a very expensive operation, possibly taking a few minutes. Before calling this function, warn the user that this is a lengthy process. You cannot change the sort order if someone else has this file open.

For Windows CE 3.0 and later, the sort orders of a database cannot be changed while a handle to that database remains open.

Changing the compression of a database affects only new and modified records.

Requirements

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

See Also

CeCreateDatabaseEx | CeOidGetInfoEx | CEDBASEINFO | CREATE_SYSTEMGUID | CeSetDatabaseInfoEx2

 Last updated on Friday, April 09, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.