RAPI Functions (Windows CE 5.0)
The following table shows the RAPI functions, with a description of the purpose of each.
| Programming element | PPC | SP | Description |
|---|---|---|---|
| CeCheckPassword (RAPI) | X | X | This function compares a specified string to the system password. |
| CeCloseHandle (RAPI) | X | X | This function closes an open object handle. |
| CeCopyFile (RAPI) | X | X | This function copies an existing file to a new file. |
| CeCreateDatabase (RAPI) | X | X | This function creates a new database. |
| CeCreateDatabaseEx (RAPI) | X | X | This function creates a new database in the object store or in a mounted volume. |
| CeCreateDirectory (RAPI) | X | X | This function creates a new directory. |
| CeCreateFile (RAPI) | X | X | This function creates, opens, or truncates a file, pipe, communications resource, disk device, or console. |
| CeCreateProcess (RAPI) | X | X | This function is used to run a new program. |
| CeDeleteDatabase (RAPI) | X | X | This function removes a database from the object store. |
| CeDeleteDatabaseEx (RAPI) | X | X | This function removes a database from the object store or a mounted database volume. |
| CeDeleteFile (RAPI) | X | X | This function deletes an existing file from the object store. |
| CeDeleteRecord (RAPI) | X | X | This function deletes a record from a database. |
| CeEnumDBVolumes (RAPI) | X | X | This function enumerates all mounted database volumes and returns the name for each. |
| CeFindAllDatabases (RAPI) | X | X | This function retrieves information about all databases of a given type residing on the Windows CE device. |
| CeFindAllFiles (RAPI) | X | X | This function retrieves information about all files and directories in the given directory of the Windows CE object store. |
| CeFindClose (RAPI) | X | X | This function closes the specified search handle. |
| CeFindFirstDatabase (RAPI) | X | X | This function opens an enumeration context to enable an application to enumerate all databases in the object store. |
| CeFindFirstDatabaseEx (RAPI) | X | X | This function opens an enumeration context for all databases in a database volume. |
| CeFindFirstFile (RAPI) | X | X | This function searches a directory for a file whose name matches the specified filename. |
| CeFindNextDatabase (RAPI) | X | X | This function retrieves the next database in an enumeration context. |
| CeFindNextDatabaseEx (RAPI) | X | X | This function retrieves the next database in an enumeration context. |
| CeFindNextFile (RAPI) | X | X | This function continues a file search from a previous call to the CeFindFirstFile (RAPI) function. |
| X | X | ||
| CeGetClassName (RAPI) | X | X | This function retrieves the name of the class to which the specified window belongs. |
| CeGetDesktopDeviceCaps (RAPI) | X | X | This function retrieves device-specific information about a specified device. |
| CeGetFileAttributes (RAPI) | X | X | This function returns attributes for a specified file or directory. |
| CeGetFileSize (RAPI) | X | X | This function retrieves the size, in bytes, of the specified file. |
| CeGetFileTime (RAPI) | X | X | This function retrieves the date and time that a file was created, last accessed, and last modified. |
| CeGetLastError (RAPI) | X | X | This function returns the calling thread's last-error code value. |
| CeGetSpecialFolderPath (RAPI) | X | X | This function gets the path to a special shell folder. |
| CeGetStoreInformation (RAPI) | X | X | This 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. |
| CeGetSystemInfo (RAPI) | X | X | This function returns information about the current system. |
| CeGetSystemMetrics (RAPI) | X | X | This function retrieves the widths and heights of Windows display elements and system configuration settings. |
| CeGetSystemPowerStatusEx (RAPI) | X | X | This function retrieves the power status of the system. |
| CeGetTempPath (RAPI) | X | X | This function gets the path to the directory designated for temporary files. |
| CeGetVersionEx (RAPI) | X | X | This function obtains extended information about the version of the operating system that is currently running. |
| CeGetWindow (RAPI) | X | X | This function retrieves the handle to a window that has the specified relationship to the specified window. |
| CeGetWindowLong (RAPI) | X | X | This function retrieves information about the specified window. |
| CeGetWindowText (RAPI) | X | X | This function copies the text of the specified window's title bar — if it has one — into a buffer. |
| CeGlobalMemoryStatus (RAPI) | X | X | This function gets information on the physical and virtual memory of the system. |
| CeMountDBVol (RAPI) | X | X | This function issues a mount request for a database volume that contains both data and an integrity log. |
| CeMoveFile (RAPI) | X | X | This function renames an existing file or a directory — including all its children. |
| CeOidGetInfo (RAPI) | X | X | This function retrieves information about an object in the object store. |
| CeOidGetInfoEx (RAPI) | X | X | This function retrieves information about an object in the object store or a mounted database volume. |
| CeOpenDatabase (RAPI) | X | X | This function opens an existing database. |
| CeOpenDatabaseEx (RAPI) | X | X | This function opens an existing database on any database volume, including mounted databases. |
| CeQueryInstructionSet (RAPI) | X | X | This function queries a Windows CE-based device to determine whether it supports the specified processor-specific instruction set. |
| CeRapiFreeBuffer | X | X | This function frees the memory on the desktop computer allocated by a call to CeFindAllDatabases, CeFindAllFiles, or CeReadRecordProps. |
| CeRapiGetError | X | X | This function reports remote API related failures. |
| CeRapiInit | X | X | This function attempts to initialize the Windows CE remote application programming interface (RAPI). |
| CeRapiInitEx | X | X | This function attempts to initialize the Windows CE remote application programming interface (RAPI) and initially returns an event handle. |
| CeRapiInvoke | X | X | This function can be used as a general-purpose mechanism to remotely execute a routine on the Windows CE device. |
| CeRapiUninit | X | X | This function uninitializes the Windows CE remote application programming interface (RAPI). |
| CeReadFile (RAPI) | X | X | This function reads data from a file, starting at the position indicated by the file pointer. |
| CeReadRecordProps (RAPI) | X | X | This function reads properties from the current record. |
| CeReadRecordPropsEx (RAPI) | X | X | This function reads properties from the current record. |
| CeRegCloseKey (RAPI) | X | X | This function releases the handle of the specified key. |
| CeRegCreateKeyEx (RAPI) | X | X | This function creates the specified key. |
| CeRegDeleteKey (RAPI) | X | X | This function deletes a named subkey from the specified registry key. |
| CeRegDeleteValue (RAPI) | X | X | This function removes a named value from the specified registry key. |
| CeRegEnumKeyEx (RAPI) | X | X | This function enumerates subkeys of the specified open registry key. |
| CeRegEnumValue (RAPI) | X | X | This function enumerates the values for the specified open registry key. |
| CeRegOpenKeyEx (RAPI) | X | X | This function opens the specified key. |
| CeRegQueryInfoKey (RAPI) | X | X | This function retrieves information about a specified registry key. |
| CeRegQueryValueEx (RAPI) | X | X | This function retrieves the type and data for a specified value name associated with an open registry key. |
| CeRegSetValueEx (RAPI) | X | X | This 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. |
| CeRemoveDirectory (RAPI) | X | X | This function deletes an existing empty directory. |
| CeSeekDatabase (RAPI) | X | X | This function seeks the specified record in an open database. |
| CeSetDatabaseInfo (RAPI) | X | X | This function sets various database parameters, including the name, type, and sort-order descriptions. |
| CeSetDatabaseInfoEx (RAPI) | X | X | This function sets various database parameters, including the name, type, sort-order descriptions, and compression of the database. |
| CeSetEndOfFile (RAPI) | X | X | This function moves the end-of-file position for the specified file to the current position of the file pointer. |
| CeSetFileAttributes (RAPI) | X | X | This function sets a file's attributes. |
| CeSetFilePointer (RAPI) | X | X | This function moves the file pointer of an open file. |
| CeSetFileTime (RAPI) | X | X | This function sets the date and time that a file was created, last accessed, or last modified. |
| CeSHCreateShortcut (RAPI) | X | X | This function creates a shortcut. |
| CeSHGetShortcutTarget (RAPI) | X | X | This function retrieves the shortcut's target path. |
| CeUnmountDBVol (RAPI) | X | X | This function unmounts a database volume. |
| CeWriteFile (RAPI) | X | X | This function writes data to a file. |
| CeWriteRecordProps (RAPI) | X | X | This function writes a set of properties to a single record, creating the record if necessary. |
| X | X |
See Also
Remote Application Programming Interface (RAPI) Reference | RAPI Enumerations | RAPI Interfaces | RAPI Structures
Send Feedback on this topic to the authors