WINCE, Windows Embedded CE - about 'Database'

WINCE, Windows Embedded CE - about 'Database'





CEGUID
 : This structure contains the globally unique identifier (GUID)of a mounted database. A CEGUID and CEOID together uniquely

identify a record or database in a database volume or in the object store.
 : (winCE Globally Unique IDentifier)

CREATE_SYSTEMGUID
 : This macro creates a CEGUID that identifies the object store database volume.
 : #define CREATE_SYSTEMGUID(pguid) (memset((pguid), 0, sizeof(CEGUID)))

HLOCAL LocalAlloc(UINT uFlags, UINT uBytes);
 : This function allocates the specified number of bytes from the heap.

HLOCAL LocalFree(HLOCAL hMem);
 : this function frees the specified local memory object and invalidate its handle.

Bool CeEnumDBVolumes(PCEGUID pceguid, LPWSTR, lpBuf, DWORD dwNumchars);
 : This method enumerates all mounted database volumes on a remote Windows Embedded CE–based device and returns the name

for each.

UINT GetLastError() const;
 : Call the GetLastError member function to get additional error information when DoModal returns IDABORT.

BOOL CeMountDBVolEx(INOUT PCEGUID pGuid,IN LPWSTR pwszDBVol, IN CEVOLUMEOPTIONS* pOptions, IN DWORD dwFlags);
 : This function mounts a volume.

VOID CeChangeDatabaseLCID(PCEGUID pceguid, DWORD LCID);
 : This function changes the locale identifier (LCID) of a database volume for sort operations.

BOOL FileTimeToLocalFileTime(const FILETIME* lpFileTime, LPFILETIME lpLocalFileTime);
 : This function converts a file time based on the UTC to a local file time.

BOOL FileTimeToSystemTime(const FILETIME* lpFileTime, LPSYSTEMTIME lpSystemTime);
 : This function converts a 64-bit file time to system time format.

// @struct CEPROPVAL | Contains a property value
// Don't define flags in low byte or high nibble
#define CEDB_PROPNOTFOUND 0x0100
#define CEDB_PROPDELETE   0x0200
typedef struct _CEPROPVAL {
    CEPROPID   propid;    //@field PropID of the value.
    WORD       wLenData;  //@field Private field - can be garbage on entry
    WORD       wFlags;    //@field Special flags for this property. Possible flags
                          //@flag CEDB_PROPNOTFOUND | Set by <f CeReadRecordProps> if property not found
                          //@flag CEDB_PROPDELETE | If passed to <f CeWriteRecordProps> it causes
                          // this property to be deleted
    CEVALUNION val;       //@field Actual value for simple types, ptr for strings/blobs                       
} CEPROPVAL, *PCEPROPVAL;
 : This structure contains a property value.

HANDLE CeFindFirstDatabaseEx(PCEGUID pceguid, DWORD dwDbaseType);
 : This function opes an enumeration contest for all databases in a mounted database volume on a remote Windows Embedded

CE-based device.

CEOID CeFindNextDatabaseEx(HANDLE hEnum, PCEGUID pceguid);
 : This method retrieves the next database in an enumeration context.

BOOL CeOidGetInfoEx2(PCEGUID pGuid, CEOID oid, CEOIDINFO* poidInfo);
 : This function obtains information about an OID that was generated by EDB.

#define CHECK_SYSTEMGUID(pguid)   ! ((pguid)->Data1 | (pguid)->Data2 | (pguid)->Data3 | (pguid)->Data4)
 : This macro checks a CEGUID to determince if it identifies the object store database volume.

BOOL CeFlushDBVol(PCEGUID pguid);
 : This function flushes information from a database volume to permanent storage.

BOOL CeUnmountDBVol(PCEGUID pguid);
 : This function unmounts a database volume on a remote Windows Embedded CE-bsed device.

HANDLE CeCreateSession(IN CEGUID* pGuid);
 : This function creates a session to begin, commit, or roll back transactions.

SORTORDERSPECEX (DB)
 : This structure contains information about a sort order in a database. The structure is used when calling the CeOpenDatabaseInSession (EDB) function and is also included in the CEDBASEINFOEX (EDB) structure.
typedef struct CESORTORDERSPECEX {
  WORD wVersion;
  WORD wNumProps;
  WORD wKeyFlags;
  WORD wReserved;
  CEPROPID rgPropID[CEDB_MAXSORTPROP];
  DWORD rgdwFlags[CEDB_MAXSORTPROP];
} CESORTORDERSPECEX;

CeOpenDatabaseInSession
 : This function opens an existing database in a mounted volume The volume must be mounted with the CeMountDBVolEx(EDB) function.
HANDLE CeOpenDatabaseInSession(
    IN HANDLE hSession,
    IN PCEGUID pGuid,
    IN PCEOID poid,
    IN LPWSTR pwszName,
    IN SORTORDERSPECEX* pSort,
    IN DWORD dwFlags,
    IN CENOTIFYREQUEST* pRequest);

CeCreateDatabaseWithProps
 : This function creates a new database in a mounted volume.
CEOID CeCreateDatabaseWithProps(
    IN PCEGUID pGuid,
    IN CEDBASEINFOEX* pInfo,
    IN DWORD cProps,
    IN CEPROPSPEC* prgProps);

HRESULT CloseHandle(HANDLE hHandle);
 : Implement this method to close the handle associated with this object.

BOOL CeDeleteDatabaseEx (PCEGUID pguid, CEOID oid);
 : This function removes a database from the object store or a mounted database volume on a remote Windows Embedded CE-based device.

BOOL CeFlushDBVol(PCEGUID pguid);
 : This function flushed information from a databse volume to permanent storage.

BOOL CeDeleteRecord (HANDLE hDatabase, CEOID oidRecord);
 : This function deletes a record from a database.

CEOID CeSeekDatabaseEx (HANDLE hDatabase, DWORD dwSeekType, DWORD dwValue,
                        WORD wNumVals, LPDWORD lpdwIndex);
 : This function seeked to a specified record in an open database.