CeSetDatabaseInfoEx

This function sets various database parameters, including the name, type, sort-order descriptions, and compression of the database.

A remote application interface (RAPI) version of this function exists, and it is also called CeSetDatabaseInfoEx.

At a Glance

Header file:	Windbase.h
Windows CE versions:	2.10 and later

Syntax

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.

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. Possible values for GetLastError include the following:

ERROR_INVALID_PARAMETER

A parameter was invalid.

ERROR_DISK_FULL

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

The CeSetDatabaseInfoEx function tried to remove a sort order that is being used by a currently 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.