CeSetDatabaseInfoEx (RAPI)

  • Article

This function sets various database parameters, including the name, type, sort-order descriptions, and compression of the database. CeSetDatabaseInfoEx (RAPI) is a remote application interface, which enables an application running on a desktop computer to make function calls on a Windows CE–based device.

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 CeGetLastError. Possible values for CeGetLastError 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.

Note   Earlier versions 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 Rapi.h    

See Also

CeCreateDatabaseEx, CeOidGetInfoEx, CeGetLastError, CEDBASEINFO, CREATE_SYSTEMGUID

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.