|
|
|
|
Name: VBRAPI Download: VBRapi.zipWhat is it: Using RAPI from VB on the desktop.Features: For Windows CE 2.0! No Rights Reserved (i.e. FreeWare) NOTE: Not all exposed functions are thoroughly tested. So use at your own risk. However, the functions used in the samples are tested thoroughly.
RemoteCE.tlb is a typelibrary that will allow the programmer to use the RAPI functions easily (hopefully) from within any COM aware development environment. For example, you can use the typelibrary to build a backup program entirely within the VBA implementation in MS Word. The RemoteCE typelibrary functions as a simple way to utilize the RAPI.dll from within Visual Basic, without the use of the 'Declare' statement. For more details about this type of typelibrary construction, consult 'Hardcore Visual Basic' by Bruce McKinney. With his book he also provides a typelibrary which covers most (if not all necessary) Window 32 API functions and constants. If you wish to use an ActiveX control which incorporate more functionality, such as connection notification, etc… just wait… Mr. Ethan Hunt (of Mission Impossible fame) is working on it… How Do I Install? You must register the typelibrary on your machine in order to use it. The use of the typelibrary is only necessary for a developer. The typelibrary does not need to ship with the application after the application is compiled. For example, to register the RemoteCE.tlb in Visual Basic 5, just go to the Project/References dialog. Select Browse and find the file RemoteCE.tlb. By selecting the file you register it on your system. How Do I Use?
Application Name: RCeCopy.exe What does it do? Demonstrates how to use the RemoteCE.tlb in a Visual Basic application to copy a file from one location to another location on the WindowsCE device.
Application Name: RCeDBList.exe What does it do? Demonstrates how to use the RemoteCE.tlb in a Visual Basic application to list the Databases on the WindowsCE device.
Application Name: RCeDBView.exe What does it do? Not included in this release
Application Name: RCeFileList.exe What does it do? Demonstrates how to use the RemoteCE.tlb in a Visual Basic application to list the Files on the WindowsCE device.
Application Name: RCeGet.exe What does it do? Demonstrates how to use the RemoteCE.tlb in a Visual Basic application to 'GET' (i.e. copy from) a file on the WindowsCE device
Application Name: RCePut.exe What does it do? Demonstrates how to use the RemoteCE.tlb in a Visual Basic application to 'PUT' (i.e. copy to) a file to the WindowsCE device.
Application Name: RCeRegView.exe What does it do? Demonstrates how to use the RemoteCE.tlb in a Visual Basic application to view the details of the registry. Works like the SDK standard 'Monkey' program.
Application Name: RCeSysInfo.exe What does it do? Demonstrates how to use the RemoteCE.tlb in a Visual Basic application to view the details of the system.
Application Group: RceGrabBag What does it do? Contains samples for various RAPI functions. These samples were used in testing. RAPI functions: This documentation helps to describe the RAPI functions as incorporated into the RemoteCE typelibrary. It is based on the original 'C/C++' documentation and therefore may have some glaring inaccuracies. [Editor: It will be continually upgraded, as knew things are added/modified/corrected] Detailed documentation for all function calls can be found in the Win32 SDK documentation. See the end of the document for the CONSTANT numbers (i.e. for example ERROR_DISK_FULL = 112) IMPORTANT NOTE: Strings passed to the typelib are ASCII. String returned from the typelib are Integer arrays (Unicode). CeCheckPassword The CeCheckPassword function compares a specified string to the system password. This function is the RAPI version of the CheckPassword function. Syntax Function CeCheckPassword(lpszPassword As String) As Long At a Glance
Parameters
Return Values Returns TRUE if lpszPassword matches the system password, else FALSE. Remarks Upon a RAPI related failure, the return value is FALSE. See Also RCeCheckPassword.frm The CeCloseHandle function closes an open object handle. This is the RAPI version of the CloseHandle function. Syntax Function CeCloseHandle(hObject As Long) As Long At a Glance
See Also RCeDBlist.vbp
The CeCopyFile function copies an existing file to a new file. This is the RAPI version of the CopyFile function. Syntax Function CeCopyFile(lpExistingFileName As String, lpNewFileName As String, bFailIfExists As Long) As Long At a Glance
Remarks Strings passed to the typelib are ascii. String returned from the typelib are Integer arrays (Unicode). See Also RCeCopyFile.vbp The CeCreateDatabase function creates a new database. Syntax Function CeCreateDatabase(lpszName As String, dwDbaseType As Long, wNumSortOrder As Integer, rgSortSpecs As SORTORDERSPEC) As ceOID At a Glance
Parameters
Return Values If the function succeeds, the return value is the object identifier of the newly created database — not a handle to an open database. If the function fails, the return value is NULL. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return one of the following values:
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. However, try not to specify too few sort orders. If you do, you can use the CeSetDatabaseInfo function to change the sort order later; however, this function is even more expensive in terms of system resources. See Also CeDeleteDatabase, CeOidGetInfo, CeOpenDatabase, CeSetDatabaseInfo, SORTORDERSPEC
The CeCreateDirectory function creates a new directory. This is the RAPI version of the CreateDirectory function. Syntax Function CeCreateDirectory(lpPathName As String, SetToNull As Any) As Long At a Glance
Remarks See Also RCeCreateDirectory.frm CeCreateFile The CeCreateFile function creates, opens, or truncates a file, pipe, communications resource, disk device, or console. It returns a handle that can be used to access the object. It can also open and return a handle to a directory. This is the RAPI version of the CreateFile function. The CreateFile function creates or opens the following objects and returns a handle that can be used to access the object:
Syntax Function CeCreateFile(lpFileName As String, dwDesiredAccess As Long, dwShareMode As Long, dwNull As Any, dwCreationDistribution As Long, dwFlagsAndAttributes As Long, hTemplateFile As Long) As Long At a Glance
Remarks See Also RCePutFile.vbp
The CeCreateProcess function is used to run a new program. It creates a new process and its primary thread. The new process executes the specified executable file. This is the remote API version of the CreateProcess function. Syntax Function CeCreateProcess(lpApplicationName As String, lpCommandLine As String, dwNull0 As Any, dwNull1 As Any, False As Long, dwCreationFlags As Long, dwNull2 As Any, dwNull4 As Any, dwNull5 As Any, lpProcessInformation As PROCESS_INFORMATION) As Long At a Glance
Remarks The name of the module to execute must be specified by the lpApplicationName parameter. Windows CE does not support passing NULL for lpApplicationName. The execution module cannot be specified in the command line string. Windows CE searches the directories indicated by the lpApplicationName parameter in the following order:
The following parameters are not supported and require the following settings:
For Windows CE version 1.0, the dwCreationFlags parameter only supports the following values: CREATE_SUSPENDED and zero. For Windows CE version 2.0, the dwCreationFlags parameter only supports the following values: CREATE_SUSPENDED, DEBUG_PROCESS, DEBUG_ONLY_THIS_PROCESS and zero. Priority classes for processes are not supported. The loader has a limited search path.
See Also RceCreateProcess.frm
CeRecordOidGetInfo The CeRecordOidGetInfo function retrieves information about a RECORD in the object store. Syntax Function CeRecordOidGetInfo(oid As ceOID, poidInfo As CERECORDOIDINFO) As Long At a Glance
Parameters
Pointer to a CERECORDOIDINFO structure that contains information about the object. This structure is a CEOIDINFO structure with the 'Union' value returning CERECORDINFO. Return Values If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information, call GetLastError. GetLastError may return ERROR_INVALID_HANDLE if the given object identifier is invalid. Remarks Use the CeRecordOidGetInfo function to retrieve information about a record in the object store database or file system. See Also
CeDirOidGetInfo The CeDirOidGetInfo function retrieves information about a DIR in the object store. Syntax Function CeDirOidGetInfo(oid As ceOID, poidInfo As CEDIROIDINFO) As Long At a Glance
Parameters
Pointer to a CEDIROIDINFO structure that contains information about the object. This structure is a CEOIDINFO structure with the 'Union' value returning CEDIRINFO. Return Values If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information, call GetLastError. GetLastError may return ERROR_INVALID_HANDLE if the given object identifier is invalid. Remarks Use the CeDirOidGetInfo function to retrieve information about a DIR in the object store database or file system. See Also
CeFileOidGetInfo The CeFileOidGetInfo function retrieves information about a FILE in the object store. Syntax Function CeFileOidGetInfo(oid As ceOID, poidInfo As CEFILEOIDINFO) As Long At a Glance
Parameters
Return Values If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information, call GetLastError. GetLastError may return ERROR_INVALID_HANDLE if the given object identifier is invalid. Remarks Use the CeFileOidGetInfo function to retrieve information about any object in the object store database or file system. See Also
CeDBaseOidGetInfo The CeDBaseOidGetInfo function retrieves information about a DBASE in the object store. Syntax Function CeDBaseOidGetInfo(oid As ceOID, poidInfo As CEDBASEOIDINFO) As Long At a Glance
Parameters
Return Values If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information, call GetLastError. GetLastError may return ERROR_INVALID_HANDLE if the given object identifier is invalid. Remarks Use the CeDBaseOidGetInfo function to retrieve information about any object in the object store database or file system. See Also RCeDBList.vbp
The CeDeleteDatabase function removes a database from the object store. Syntax Function CeDeleteDatabase(oidDbase As ceOID) As Long At a Glance
Parameters
Return Values If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return one of the following values:
Remarks The CeDeleteDatabase function deletes a database, including all records in the database. See Also CeCreateDatabase
The CeDeleteFile function deletes an existing file from the object store. This function is the RAPI version of the DeleteFile function. Syntax Function CeDeleteFile(lpFileName As String) As Long At a Glance
Remarks See Also RceDeleteFile.frm The CeDeleteRecord function deletes a record from a database. Syntax Function CeDeleteRecord(hDatabase As Long, oidRecord As ceOID) As Long At a Glance
Parameters
Return Values If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return ERROR_INVALID_PARAMETER if the handle or object identifier is invalid. Remarks If the CEDB_AUTOINCREMENT flag was not specified when the database was opened, and the record being deleted is the current record, the next read operation that uses the database handle will fail. If the CEDB_AUTOINCREMENT flag was specified, the system automatically moves the current seek pointer forward by one. See Also CeOpenDatabase
Not available in the RemoteCE.tlb. Use CeFindFirstDatabase and CeFindNextDatabase. See Also RceDblist.vbp Not available in the RemoteCE.tlb. Use CeFindFirstFile and CeFindNextFile See Also RCeFilelist.vbp CeFindClose The CeFindClose function closes the specified search handle. This is the RAPI version of the FindClose function. Syntax Function CeFindClose(hFindFile As Long) As Long At a Glance
Remarks See Also
The CeFindFirstDatabase function opens an enumeration context for all databases in the system. A RAPI version of this function exists and is also called CeFindFirstDatabase. Syntax Function CeFindFirstDatabase(dwDbaseType As Long) As Long At a Glance
Parameters
Return Values If the function succeeds, the return value is a handle to an enumeration context. To find the next database of the given type, specify the handle in a call to the CeFindNextDatabase function. If the function fails, the return value is INVALID_HANDLE_VALUE. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return ERROR_OUTOFMEMORY if no memory is available to allocate a database handle. Remarks Use the CeCloseHandle function to close the handle returned by the CeFindFirstDatabase function. See Also RceDblist.vbp The CeFindFirstFile function searches a directory for a file whose name matches the specified filename. CeFindFirstFile examines subdirectory names as well as filenames. This is the RAPI version of the FindFirstFile function. Syntax Function CeFindFirstFile(lpFileName As String, lpFindFileData As CE_FIND_DATA) As Long At a Glance
Remarks See Also RceFilelist.vbp The CeFindNextDatabase function retrieves the next database in an enumeration context. A RAPI version of this function exists and is also called CeFindNextDatabase. Syntax Function CeFindNextDatabase(hEnum As Long) As ceOID At a Glance
Parameters
Return Values If the function succeeds, the return value is the object identifier of the next database to be enumerated. If no more databases are left to enumerate, or if an error occurs, the return value is zero. To get extended error information, when within a CE program call GetLastError. If within a RAPI program call CeGetLastError. GetLastError and CeGetLastError may return one of the following values:
Remarks See Also RCeDBList.vbp The CeFindNextFile function continues a file search from a previous call to the CeFindFirstFile function. This is the RAPI version of the FindNextFile function. Syntax Function CeFindNextFile(hFindFile As Long, lpFindFileData As CE_FIND_DATA) As Long At a Glance
Remarks See Also RceFileList.vbp The CeGetClassName function retrieves the name of the class to which the specified window belongs. This is the RAPI version of the GetClassName function. Syntax Function CeGetClassName(hWnd As Long, lpString As String, nMaxCount As Long) As Long At a Glance
Remarks Returned ClassName is Unicode. See Also
The CeGetDesktopDeviceCaps function retrieves device-specific information about a specified device. This is the RAPI version of the GetDeviceCaps function. Syntax Function CeGetDesktopDeviceCaps(nIndex As Long) As Long At a Glance
Remarks See Also RceSysInfo.vbp CeGetFileAttributes The CeGetFileAttributes function returns attributes for a specified file or directory. This is the RAPI version of the GetFileAttributes function. Syntax Function CeGetFileAttributes(lpFileName As String) As Long At a Glance
Remarks See Also RceGetFileAttributes.frm The CeGetFileSize function retrieves the size, in bytes, of the specified file. This is the RAPI version of the GetFileSize function. Syntax Function CeGetFileSize(hFile As Long, lpFileSizeHigh As Long) As Long At a Glance
Remarks See Also RceGetFileSize.frm The CeGetFileTime function retrieves the date and time that a file was created, last accessed, and last modified. This is the RAPI version of the GetFileTime function. Syntax Function CeGetFileTime(hFile As Long, lpCreationTime As FILETIME, lpLastAccessTime As FILETIME, lpLastWriteTime As FILETIME) As Long At a Glance
Remarks See Also RceGetFileTime.frm The CeGetLastError function returns the calling thread’s last error code. This is the RAPI version of the GetLastError function. Syntax Function CeGetLastError() As Long At a Glance
Remarks See Also
The CeGetSpecialFolderPath function gets the path to a special shell folder. Syntax Function CeGetSpecialFolderPath(nFolder As Long, nBufferLength As Long, lpBuffer As String) As Long At a Glance
Parameters
Return Values The return value is the length of the returned string; if a RAPI related failure, return value is FALSE.
The CeGetStoreInformation function fills in a STORE_INFORMATION structure with the size of the object store and the amount of free space currently in the object store. This is the RAPI version of GetStoreInformation. Syntax Function CeGetStoreInformation(lpsi As STORE_INFORMATION) As Long At a Glance
Remarks Upon a RAPI-related failure, the return value is FALSE. See Also RceGetStoreInformation.frm
The CeGetSystemInfo function returns information about the current system. This is the RAPI version of the GetSystemInfo function. Syntax Sub CeGetSystemInfo(lpSystemInfo As SYSTEM_INFO) At a Glance
Remarks See Also CeGetSystemMetrics The CeGetSystemMetrics function retrieves the dimensions (widths and heights) of Windows display elements and system configuration settings. All dimensions retrieved by CeGetSystemMetrics are in pixels. This is the RAPI version of the GetSystemMetrics function. Syntax Function CeGetSystemMetrics(nIndex As Long) As Long At a Glance
Remarks See Also CeGetSystemPowerStatusEx The CeGetSystemPowerStatusEx function retrieves the power status of the system. The status indicates whether the system is running on AC or DC power, whether or not the batteries are currently charging, and the remaining life of main and backup batteries. This is the RAPI version of the GetSystemPowerStatusEx function. Syntax Function CeGetSystemPowerStatusEx(pstatus As SYSTEM_POWER_STATUS_EX, fUpdate As Long) As Long At a Glance
Parameters
Return Values This function returns TRUE if successful, otherwise FALSE. Remarks See Also CeGetTempPath This function does not work correctly. The CeGetTempPath function gets the path to the directory designated for temporary files. Syntax Function CeGetTempPath(nBufferLength As Long, lpBuffer As String) As Long At a Glance
Parameters
Return Values The return value is the length, in characters, of the string copied to lpBuffer, not including the terminating null character. If the return value is greater than nBufferLength, the return value is the size of the buffer required to hold the path. The returned value is a Unicode string. Use an integer array to retrieve the string. If CeGetTempPath fails, the return value is 0. To get extended error information, call CeGetLastError. Remarks The CeGetTempPath function gets the temporary file path as follows: 1. The path specified by the TMP environment variable. 2. The path specified by the TEMP environment variable, if TMP is not defined. 3. The current directory, if both TMP and TEMP are not defined.
The CeGetVersionEx function obtains extended information about the version of the operating system that is currently running. This is the RAPI version of the GetVersionEx function. Syntax Function CeGetVersionEx(lpVersionInformation As CEOSVERSIONINFO) As Long At a Glance
Remarks When writing applications for Windows CE Japanese 2.01 be aware that the Tool Bar will indicate that the version is 2.0. See Also RceSysInfo.vbp The CeGetWindow function retrieves the handle to a window that has the specified relationship to the specified window. This is the RAPI version of the GetWindow function. Syntax Function CeGetWindow(hWnd As Long, uCmd As Long) As Long At a Glance
Remarks See Also
The CeGetWindowLong function retrieves information about the specified window. CeGetWindowLong also retrieves the 32-bit (long) value at the specified offset into the extra window memory of a window. This is the RAPI version of the GetWindowLong function. Syntax Function CeGetWindowLong(hWnd As Long, nIndex As Long) As Long At a Glance
Remarks See Also
The CeGetWindowText function copies the text of the specified window’s title bar (if it has one) into a buffer. If the specified window is a control, the text of the control is copied. This is the RAPI version of the GetWindowText function. Syntax Function CeGetWindowText(hWnd As Long, lpString As String, nMaxCount As Long) As Long At a Glance
Remarks See Also
The CeGlobalMemoryStatus function gets information on the physical and virtual memory of the system. This is the RAPI version of the GlobalMemoryStatus function. Syntax Sub CeGlobalMemoryStatus(lpmst As MEMORYSTATUS) At a Glance
Remarks See Also CeMoveFile The CeMoveFile function renames an existing file or a directory — including all its children. This is the RAPI version of the MoveFile function. Syntax Function CeMoveFile(lpExistingFileName As String, lpNewFileName As String) As Long At a Glance
Remarks See Also
Use the CeDBaseOidGetInfo, CeDirOidGetInfo, CeFileOidGetInfo, amd CeRecordOidGetInfo to retrieve information from the respective Object Store Items. CeOpenDatabase The CeOpenDatabase function opens an existing database. Syntax Function CeOpenDatabase(poid As ceOID, lpszName As String, propid As cePROPID, dwFlags As Long, hwndNotify As Long) As Long At a Glance
Parameters
Return Values If the function succeeds, the return value is a handle to the open database. If the function fails, the return value is INVALID_HANDLE_VALUE. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return one of the following values:
Remarks Use the CeCloseHandle function to close the handle returned by the CeOpenDatabase function. Unlike many other traditional databases, opening and closing a database does not imply any transactioning. In other words, the database is not committed at the closing—it is committed after each individual call. See Also
The CeRapiFreeBuffer function frees the memory on the desktop PC allocated by a call to CeReadRecordProps. Syntax HRESULT CeRapiFreeBuffer(LPVOID Buffer); At a Glance
Parameters
Return Values If the function completes successfully it returns the value SOK, otherwise it returns E_FAIL. Remarks Any RAPI function that allocates memory on the desktop PC on the users behalf must be freed by calling the CeRapiFreeBuffer function. See Also CeReadRecordProps
The CeRapiGetError function reports remote API related failures. CeRapiGetError can be used to determine if a call failed due to a failure in the remote API. Syntax Function CeRapiGetError() As Long At a Glance
Parameters None. Return Values This function returns standard Win32 error values. Remarks
The CeRapiInit function attempts to initialize the Windows CE Remote API. Syntax Function CeRapiInit() As Long At a Glance
Parameters None. Return Values If this function succeeds, the return value is E_SUCCESS. If this function is called when already initialized, it returns E_FAIL. Remarks The functions CeRapiInit or CeRapiInitEx must be called before any remote API calls can be performed. They initialize the underlying communications layers between the desktop PC and the target platform device. A call to CeRapiInit does not return until the connection is made, an error occurs, or another thread calls CeRapiUninit. The CeRapiInitEx function does not block the calling thread. Instead, it uses an event to signal when initialization is complete. See Also All sample applications
The CeRapiInitEx function attempts to initialize the Windows CE Remote API and initially returns an event handle. Avoid this function. Syntax Function CeRapiInitEx(pRapiInit As RAPIINIT) As Long At a Glance
Parameters
Return Values If this function initially succeeds, it returns E_SUCCESS. If this function is called when RAPI is already initialized, it returns E_FAIL. Remarks The CeRapiInitEx or CeRapiInit functions must be called before any remote API calls can be performed. They initialize the underlying communications layers between the desktop PC and the target platform device. Call CeRapiInitEx to avoid blocking a thread inside of a call to CeRapiInit. CeRapiInitEx returns immediately and continues initialization until the connection is made, until an error occurs, or until there is a call to CeRapiUninit. When CeRapiInitEx is complete it then sets the event specified in the heRapiInit member of the RAPIINIT structure. After calling CeRapiInitEx, check the return value to see if an error occurred. If the call was initially successful, call the MsgWaitForMultipleObjects function to wait on the event handle passed back in the heRapiInit member of the RAPIINIT structure. When the event is set, check the hrRapiInit member of the structure to determine if the connection was successful. To shut down or to abort the connection process, call the CeRapiUnInit function. See Also
The CeRapiUnInit function uninitializes the Windows CE Remote API. Use CeRapiInit and CeRapiUninit to open and close sessions with the Windows CE devices. Syntax Function CeRapiUninit() As Long At a Glance
Parameters None. Return Values If this function is called when not initialized, it will return E_FAIL. Remarks The CeRapiUnInit function should be called when the application has completed its use of the remote API services. It gracefully closes down the connection to the Windows CE device. If called when not in an initialized state, it will return E_FAIL.
The CeReadFile function reads data from a file, starting at the position indicated by the file pointer. After the read operation has been completed, the file pointer is adjusted by the number of bytes actually read. This is the RAPI version of the ReadFile function. Using this version of CeReadFile will return a byte array. Review the sample file (RceGetFile.vbp) to see how the lpBuffer should be initialized and used in Visual Basic. Syntax Function CeReadFile(hFile As Long, lpBuffer As Any, nNumberOfBytesToRead As Long, lpNumberOfBytesRead As Long, CeReadFileNull As Long) As Long At a Glance
Remarks See Also ReadFile
CeReadFileStr The CeReadFileStr function reads data from a file, starting at the position indicated by the file pointer. After the read operation has been completed, the file pointer is adjusted by the number of bytes actually read. This is the RAPI version of the ReadFile function. Using this version of CeReadFileStr will return a string. Review the sample file (RceGetFile.vbp) to see how the lpBuffer should be initialized and used in Visual Basic. Syntax Function CeReadFileStr(hFile As Long, lpBuffer As String, nNumberOfBytesToRead As Long, lpNumberOfBytesRead As Long, CeReadFileNull As Long) As Long At a Glance
Remarks See Also ReadFile
The CeReadRecordProps function reads properties from the current record. This function is untested. Syntax Function CeReadRecordProps(hDbase As Long, dwFlags As Long, lpcPropID As <Unsupported variant type>, rgPropID As cePROPID, lplpBuffer As Byte, lpcbBuffer As Long) As ceOID At a Glance
Parameters
Return Values If the function succeeds, the return value is the object identifier of the record from which the function read. If the function fails, the return value is zero. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return one of the following values:
Remarks The CeReadRecordProps function reads the specified set of properties from the current record. If the database was opened with the autoseek flag — that is, if the dwFlags parameter of CeOpenDatabase was set to CEDB_AUTOINCREMENT — CeReadRecordProps increments the seek pointer by one so that the next call reads the next record in the current sort order. That is, if the database was opened with a sort order active, then CeReadRecordProps will return the records in sorted order. If the database was not opened with a sort order active, then the order in which records are returned is not predictable. Read all needed properties from the record in a single call. The entire record is stored in a compressed format, and each time a property is read it must be decompressed. All the properties are returned in a single marshalled structure, which consists of an array of CEPROPVAL structures, one for each property requested — or one for each property found if the application set the rgPropID parameter to NULL when calling the function. If a property was requested, such as strings or blobs that are packed in at the end of the array, the pointers in the CEPROPVAL structures point into this marshalled structure. This means that the only memory that must be freed is the original pointer to the buffer passed in to the call. Even if the function fails, it may have allocated memory on the caller’s behalf. Free the pointer returned by this function if the pointer is not NULL. See Also
The CeRegCloseKey function releases the handle to the specified key. This is the RAPI version of the RegCloseKey function. Syntax Function CeRegCloseKey(hKey As Long) As Long At a Glance
Remarks See Also RceRegView.vbp The CeRegCreateKeyEx function creates the specified key. If the key already exists in the registry, CeRegCreateKeyEx opens it. This is the RAPI version of the RegCreateKeyEx function. Syntax Function CeRegCreateKeyEx(hKey As Long, lpszSubKey As String, dwReserved As Long, lpszClass As String, dwOptions As Long, samDesired As Long, lpSecurityAttributes As _SECURITY_ATTRIBUTES, phkResult As Long, lpdwDisposition As Long) As Long At a Glance
Remarks See Also
The CeRegDeleteKey function deletes a key and all its descendants. This is the RAPI version of the RegDeleteKey function. Syntax Function CeRegDeleteKey(hKey As Long, lpszSubKey As String) As Long At a Glance
Remarks See Also
The CeRegDeleteValue function removes a named value from the specified registry key. This is the RAPI version of the RegDeleteValue function. Syntax Function CeRegDeleteValue(hKey As Long, lpszValueName As String) As Long At a Glance
Remarks See Also
The CeRegEnumKeyEx function enumerates subkeys of the specified open registry key. CeRegEnumKeyEx retrieves information about one subkey each time it is called; it retrieves the class name of the subkey and the time it was last modified. This is the RAPI version of the RegEnumKeyEx function. Syntax Function CeRegEnumKeyEx(hKey As Long, dwIndex As Long, lpszName As Any, lpcchName As Long, lpReserved As Long, lpszClass As String, lpcchClass As Long, lpftLastWrite As FILETIME) As Long At a Glance
Remarks
The CeRegEnumValue function enumerates the values for the specified open registry key. CeRegEnumValue copies one indexed value name and data block for the key each time it is called. This is the RAPI version of the RegEnumValue function. Syntax Function CeRegEnumValue(hKey As Long, dwIndex As Long, lpszName As Any, lpcchName As Long, lpReserved As Long, lpType As Long, lpData As Any, lpcbData As Long) As Long At a Glance
Remarks See Also RceRegView.vbp The CeRegOpenKeyEx function opens the specified key. This is the RAPI version of the RegOpenKeyEx function. Syntax Function CeRegOpenKeyEx(hKey As Long, lpszSubKey As String, dwReserved As Long, samDesired As Long, phkResult As Long) As Long At a Glance
Remarks See Also
The CeRegQueryInfoKey function retrieves information about a specified registry key. This is the RAPI version of the RegQueryInfoKey function. Syntax Function CeRegQueryInfoKey(hKey As Long, lpszClass As Any, lpcchClass As Long, lpReserved As Long, lpcSubKeys As Long, lpcchMaxSubKeyLen As Long, lpcchMaxClassLen As Long, lpcValues As Long, lpcchMaxValueNameLen As Long, lpcbMaxValueData As Long, lpcbSecurityDescriptor As Long, lpftLastWriteTime As Any) As Long At a Glance
Remarks See Also
The CeRegQueryValueEx function retrieves the type and data for a specified value name associated with an open registry key. This is the RAPI version of the RegQueryValueEx function. Syntax Function CeRegQueryValueEx(hKey As Long, lpszValueName As Any, lpReserved As Long, lpType As Long, lpData As Byte, lpcbData As Long) As Long At a Glance
Remarks See Also
The CeRegSetValueEx function stores data in the value field of an open registry key. It can also set additional value and type information for the specified key. This is the RAPI version of the RegSetValueEx function. Syntax Function CeRegSetValueEx(hKey As Long, lpValueName As String, Reserved As Long, dwType As Long, lpData As Byte, cbData As Long) As Long At a Glance
Remarks See Also
The CeRemoveDirectory function deletes an existing empty directory. This is the RAPI version of the RemoveDirectory function. Syntax Function CeRemoveDirectory(lpPathName As String) As Long At a Glance
Remarks See Also The CeSeekDatabase function seeks the specified record in an open database. Syntax Function CeSeekDatabase(hDatabase As Long, dwSeekType As Long, dwValue As Long, lpdwIndex As Long) As ceOID At a Glance
Parameters
Return Values If the function succeeds, the return value is the object identifier of the record on which the seek ends. If the function fails, the return value is zero. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return ERROR_INVALID_PARAMETER if a parameter is invalid. Remarks The CeSeekDatabase function always uses the current sort order as specified in the call to the CeOpenDatabase function. If the CEDB_AUTOINCREMENT flag was specified, an automatic seek of one from the current position is done with each read operation that occurs on the database. Note that a seek can only be performed on a sorted property value. After creating a database (using CeCreateDatabase) and opening the database (using CeOpenDatabase), subsequent calls to CeSeekDatabase assume the sort order that was specified in the propid parameter of the call to CeOpenDatabase. Although property identifiers can be modified using CeWriteRecordProps, it is best to use the same property identifier for CeOpenDatabase that was used for the propid member of the SORTORDERSPEC structure that was passed in the call to CeCreateDatabase. To enter negative values for the CEDB_SEEK_CURRENT case, cast a signed long. This changes the effective range on the record indexes to 31 bits from 32. Multiple sort orders cannot be specified for a single property. See Also
The CeSetDatabaseInfo function sets various database parameters, including the name, type, and sort-order descriptions. Syntax Function CeSetDatabaseInfo(oidDbase As ceOID, pNewInfo As CEDBASEINFO) As Long At a Glance
Parameters
Return Values If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return one of the following values:
Remarks The CeSetDatabaseInfo function can be used to change the database parameters passed in while creating the database. Note that changing the sort order of the database can take several minutes. Before calling CeSetDatabaseInfo, an application should warn the user that this operation can be lengthy. See Also
The CeSetEndOfFile function moves the end-of-file position for the specified file to the current position of the file pointer. This is the RAPI version of the SetEndOfFile function. Syntax Function CeSetEndOfFile(hFile As Long) As Long At a Glance
Remarks See Also
The CeSetFileAttributes function sets a file’s attributes. This is the RAPI version of the SetFileAttributes function. Syntax Function CeSetFileAttributes(lpFileName As String, dwFileAttributes As Long) As Long At a Glance
Remarks See Also
The CeSetFilePointer function moves the file pointer of an open file. This is the RAPI version of the SetFilePointer function. Syntax Function CeSetFilePointer(hFile As Long, lDistanceToMove As Long, lpDistanceToMoveHigh As Long, dwMoveMethod As Long) As Long At a Glance
Remarks See Also
The CeSetFileTime function sets the date and time that a file was created, last accessed, or last modified. This is the RAPI version of the SetFileTime function. Syntax Function CeSetFileTime(hFile As Long, lpCreationTime As FILETIME, lpLastAccessTime As FILETIME, lpLastWriteTime As FILETIME) As Long At a Glance
Remarks See Also
The CeSHCreateShortcut function creates a shortcut. This is the RAPI version of the SHCreateShortcut function. Syntax Function CeSHCreateShortcut(lpszShortcut As String, lpszTarget As String) As Long At a Glance
Remarks See Also
The CeSHGetShortcutTarget function retrieves the shortcut’s target path. This is the RAPI version of the SHGetShortcutTarget function. Syntax Function CeSHGetShortcutTarget(lpszShortcut As String, lpszTarget As String, Arg3 As Long) As Long At a Glance
Remarks See Also CeWriteFile The CeWriteFile function writes data to a file. CeWriteFile starts writing data to the file at the position indicated by the file pointer. After the write operation has been completed, the file pointer is adjusted by the number of bytes actually written. This is the RAPI version of the WriteFile function. This function call writes data from a byte array. See RcePutFile.vbp. Syntax Function CeWriteFile(hFile As Long, lpBuffer As Any, nNumberOfBytesToWrite As Long, lpNumberOfBytesWritten As Long, CeWriteFileNull As Long) As Long At a Glance
Remarks See Also
CeWriteFileStr The CeWriteFileStr function writes data to a file. CeWriteFileStr starts writing data to the file at the position indicated by the file pointer. After the write operation has been completed, the file pointer is adjusted by the number of bytes actually written. This is the RAPI version of the WriteFile function. This function call writes data from a string. See RcePutFile.vbp. Syntax Function CeWriteFileStr(hFile As Long, lpBuffer As String, nNumberOfBytesToWrite As Long, lpNumberOfBytesWritten As Long, CeWriteFileNull As Long) As Long At a Glance
Remarks See Also
The CeWriteRecordProps function writes a set of properties to a single record, creating the record if necessary. A RAPI version of this function exists and is also called CeWriteRecordProps. Syntax Function CeWriteRecordProps(hDbase As Long, oidRecord As ceOID, cPropID As Integer, rgPropVal As CEPROPVAL) As ceOID At a Glance
Parameters
Return Values If the function succeeds, the return value is the object identifier of the record to which the properties were written. If the function fails, the return value is zero. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return one of the following values:
Remarks The CeWriteRecordProps function writes all the requested properties into the specified record. CeWriteRecordProps does not move the seek pointer. To delete a property, set the CEDB_PROPDELETE flag in the appropriate property value. This allows multiple deletes and changes in a single call, which is much more efficient than multiple calls.
Error Codes:
This page was last updated on 06/04/99. |
|
Feedback mailto:ppcdev@conduits.com
|
