CeMountDBVol

This function issues a mount request for a database volume that contains both data and an integrity log. The function returns a CEGUID that is the globally unique identifier of a mounted database.

A remote application interface (RAPI) version of this function exists, and it is also called CeMountDBVol.

At a Glance

Header file: Windbase.h
Windows CE versions: 2.10 and later

Syntax

BOOL CeMountDBVol( PCEGUID pceguid, LPWSTR lpszDBVol,
DWORD dwFlags );

Parameters

pceguid

[in] Pointer to a buffer that contains the CEGUID that contains the globally unique identifier of a mounted database.

lpszDBVol

[in] Pointer to the null-terminated string that contains the file name of the database volume to be mounted. The path is limited to MAX_PATH characters and includes the NULL character.

dwFlags

[in] Specifies how the database volume is opened. It is one of the following flags:

Value Description
CREATE_NEW Creates a new database volume. The function fails if the specified database volume already exists.
CREATE_ALWAYS Creates a new database volume. The function overwrites the database volume if it exists.
OPEN_EXISTING Opens the database volume. The function fails if the database volume does not exist.
OPEN_ALWAYS Opens the database volume, if it exists. If the database volume does not exist, the function creates the database volume as if CREATE_NEW was specified.
TRUNCATE_EXISTING Opens the database volume. Once opened, the database volume is truncated so that its size is zero bytes. The function fails if the database volume does not exist.

Return Values

TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError. Possible values for GetLastError include the following:

ERROR_DISK_FULL

The mounted volume does not have space to create the new database.

ERROR_INVALID_PARAMETER

A parameter was invalid.

ERROR_NOT_ENOUGH_MEMORY

There was not enough memory available to create volume.

If the database volume already exists before the function call and dwFlags is CREATE_ALWAYS or OPEN_ALWAYS, GetLastError returns ERROR_ALREADY_EXISTS, even though the function has succeeded.

Remarks

The CeMountDBVol function creates a database volume that contains both data and an integrity log. The function can accept any path including Uniform Naming Convention (UNC) names for files on a LAN.

A single database volume can be mounted more than once by a different application. Each time the volume is mounted, a reference count is incremented. A mounted database volume does not unmount until all applications that mounted the volume call CeUnmountDBVol. CeUnmountDBVol must be called to free up system resources.

All data written to a mounted database volume is cached until one of the following occurs:

See Also

CeUnmountDBVol, CHECK_INVALIDGUID