CeSetDatabaseInfo (CEDB) (Compact 2013)

  • Article

3/26/2014

This function sets database parameters, including the name, type, and sort-order descriptions. This function is obsolete. Call the CeSetDatabaseInfoEx (CEDB) function 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 [CEDB] structure that contains new parameter information for the database. The wNumRecords member of the structure is not used.

Return Value

TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError. The following table lists possible values.

Value

Description

ERROR_DISK_FULL

Indicates that 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, but only by a small amount.

ERROR_INVALID_PARAMETER

Indicates that a parameter was invalid.

ERROR_SHARING_VIOLATION

Indicates that this function tried to remove a sort order that is being used by a currently open database.

Remarks

Requirements

Header

windbase.h

Library

coredll.lib

See Also

Reference

CEDB Functions
CeCreateDatabase (CEDB)
CeOidGetInfo (CEDB)
CEDBASEINFO [CEDB]
CeSetDatabaseInfoEx2 (CEDB)