CeSetDatabaseInfo

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, and sort-order descriptions. This function is obsolete. Applications should call CeSetDataBaseInfoExinstead.

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

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 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 within a Windows CE program, call GetLastError. Possible values for GetLastErrorinclude the following:

ERROR_INVALID_PARAMETER

A parameter was invalid.

ERROR_DISK_FULL

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

CeSetDatabaseInfotried to remove a sort order that is being used by a currently open database.

Remarks

The CeSetDatabaseInfofunction 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.

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	1.01 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.