IRAPISession::CeSetDatabaseInfo

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method sets parameters for a database in the object store on a remote Windows Embedded CE–based device. The parameters that can be set include the name, type, and sort-order descriptions.

Note

This method has been deprecated. Use IRAPISession::CeSetDatabaseInfoEx instead.

Syntax

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 CEDBASEINFO structure that contains new parameter information for the database. The wNumRecords member of the structure is not used.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information within a RAPI program, call IRAPISession::CeGetLastError. Possible values for IRAPISession::CeGetLastError include 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 can change the size of the stored records, though not by much.
  • ERROR_SHARING_VIOLATION
    The method tried to remove a sort order that is being used by a currently open database.

Remarks

The IRAPISession::CeSetDatabaseInfo method can be used to change the database parameters that were set when the database was created. Note that changing the sort order of the database can take several minutes. Before calling IRAPISession::CeSetDatabaseInfo, an application should warn the user that this operation can be lengthy.

Note

Earlier versions of Windows Embedded CE assigned object identifiers to objects in other file systems, such as the file allocation table (FAT) file system. These object identifiers 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 object identifiers and the object store is the only volume that can return an object identifier.

For Windows Embedded CE versions 2.10 through 2.12, do not call this function on an open database. For Windows Embedded CE versions 3.0 and later, the sort orders of a database cannot be changed while a handle to that database remains open.

Requirements

Header rapi2.h
Library ole32.lib, rapiuuid.lib
Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

IRAPISession
IRAPISession::CeCreateDatabaseEx
IRAPISession::CeSetDatabaseInfoEx
CEDBASEINFO
IRAPISession::CeOidGetInfo
IRAPISession::CeOidGetInfoEx