CeSetDatabaseInfoEx

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

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.

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

Parameters

pceguid

[in] Pointer to the CEGUIDthat 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 CEDBASEINFOstructure that contains new parameter information for the database. The wNumRecordsmember of the structure is not used.

Return Values

TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError. Possible values for GetLastErrorinclude 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 CeSetDatabaseInfoExfunction tried to remove a sort order that is being used by a currently open database. For Windows versions 3.0 and later, indicates that CeSetDatabaseInfoExwas called on an open database.

Remarks

Use CeSetDatabaseInfoExto 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 can not change the sort order if someone else has this file open.

For Windows CE versions 2.10 through 2.12, do not call this function on an open database.

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

Note Earlier versions (2.12 and prior) of Windows CE assigned OIDs to objects in other file systems, such as the FAT file system. These OIDs were guaranteed to be unique within a volume, but not across multiple volumes. Effective with version 3.0, only objects in the object store have valid, unique OIDs and the object store is the only volume that can return an object identifier.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	2.10 and later	Windbase.h	Winbase.h	Fsdbase.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.