IRAPISession::CeCreateDatabase

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method creates a new database in the object store on a remote Windows Embedded CE–based device.

Syntax

CEOID CeCreateDatabase(
  LPWSTR lpszName,
  DWORD dwDbaseType,
  WORD wNumSortOrder,
  SORTORDERSPEC * rgSortSpecs
);

Parameters

• lpszName
  [in] Long pointer to a null-terminated string that specifies the name for the new database. The name can have up to 32 characters, including the terminating null character. If the name is too long, it is truncated and the database is created. Do not use an empty string as the database name.

• dwDbaseType
  [in] Specifies the type identifier for the database. This is an application-defined value that can be used for any application-defined purpose. For example, an application can use the type identifier to distinguish address book data from to-do list data or use the identifier during a database enumeration sequence. See IRAPISession::CeFindFirstDatabase for details. The type identifier is not meant to be a unique identifier for the database. The system does not use this value.

• wNumSortOrder
  [in] Number of sort orders active in the database, with four (CEDB_MAXSORTORDER = 4) being the maximum number. This parameter can be zero if no sort orders are active. If this value is zero then the database engine creates a default sort order where "rgSortSpecs[0].propid = 0", and "rgSortSpecs[0].dwFlags = CEDB_SORT_GENERICORDER". This is only a placeholder and does not influence the insertion order of the records.

• rgSortSpecs
  [in] Pointer to an array of SORTORDERSPEC structures containing sort order descriptions. The size of the array is specified by wNumSortOrder. This parameter can be NULL if wNumSortOrder is zero.

Return Value

The object identifier of the newly created database — not a handle to an open database — indicates success. NULL indicates failure. To get extended error information within a RAPI program, call IRAPISession::CeGetLastError. Possible values for IRAPISession::CeGetLastError include the following:

• ERROR_DISK_FULL
  The object store does not contain enough space to create the new database.

• ERROR_INVALID_PARAMETER
  A parameter was invalid.

• ERROR_DUP_NAME
  A database already exists with the specified name.

Remarks

Because sort orders increase the system resources needed to perform each insert and delete operation, keep the number of sort orders to a minimum. You can use the IRAPISession::CeSetDatabaseInfo function to change the sort order later.

Requirements

See Also

Reference

IRAPISession
IRAPISession::CeDeleteDatabase
IRAPISession::CeFindFirstDatabase
IRAPISession::CeOidGetInfo
IRAPISession::CeOpenDatabase
IRAPISession::CeCreateDatabaseEx