IRAPISession
A version of this page is also available for
4/8/2010
This interface allows desktop applications to perform Remote API 2 operations on a connected Windows Embedded CE–based remote device. The set of methods in this interface is the same as the functions provided by the original version of the Remote API, but the underlying implementation of this library provides increased performance and reliability.
A reference to this interface can be obtained by from the IRAPIDevice interface.
Methods
The following table shows the methods for this interface in alphabetical order. Like all COM interfaces, this interface inherits the methods for the IUnknown interface.
Method | Description |
---|---|
Compares a specified string to the system password on a Windows Embedded CE–based remote device. |
|
Closes an open object handle that was created using RAPI or RAPI2 APIs. |
|
Copies an existing file on a Windows Embedded CE–based remote device to a new file on the remote device. |
|
Creates a new database in the object store on a Windows Embedded CE–based remote device. |
|
Creates a new database in the object store or in amounted volume on a Windows Embedded CE–based remote device. |
|
Creates a new directory on a Windows Embedded CE–based remote device. |
|
Creates, opens, or truncates a file, pipe, communications resource, disk device, or console on a Windows Embedded CE–based remote device. |
|
Run a program on a Windows Embedded CE–based remote device. |
|
Removes a database from the object store on a Windows Embedded CE–based remote device. |
|
Removes a database from the object store or a mounted database volume on a Windows Embedded CE–based remote device. |
|
Deletes a file from the object store on a Windows Embedded CE–based remote device. |
|
Deletes a record from a database on a Windows Embedded CE–based remote device. |
|
Enumerates all mounted database volumes on a Windows Embedded CE–based remote device and returns the name for each. |
|
Retrieves information about all databases of a specified type residing on a Windows Embedded CE–based remote device. |
|
Retrieves information about all files and directories in the given directory of the Windows Embedded CE object store on a remote device. |
|
Closes the specified search handle on a Windows Embedded CE–based remote device. |
|
Opens an enumeration context to enable an application to enumerate all databases in the object store on a Windows Embedded CE–based remote device. |
|
Opens an enumeration context for all databases in a mounted database volume on a Windows Embedded CE–based remote device. |
|
Searches for a file or subdirectory in a directory on a Windows Embedded CE–based remote device. |
|
Retrieves the next database in an enumeration context. |
|
Retrieves the next database in an enumeration context. |
|
Retrieves the next file in an enumeration context. |
|
Retrieves the name of the class to which the specified window on a Windows Embedded CE–based remote device belongs. |
|
Retrieves device-specific information about a Windows Embedded CE–based remote device. |
|
Retrieves information about the amount of space that is available on a disk volume on a Windows Embedded CE–based remote device. |
|
Returns attributes for a specified file or directory on a Windows Embedded CE–based remote device. |
|
Retrieves the size, in bytes, of the specified file on a Windows Embedded CE–based remote device. |
|
Retrieves the date and time that a file was created, last accessed, and last modified for a file on a Windows Embedded CE–based remote device. |
|
Returns the calling thread's last-error code value related to RAPI2 method calls. |
|
Retrieves the path to a special shell folder on a Windows Embedded CE–based remote device. |
|
Fills in aSTORE_INFORMATION structure with the size of the object store and the amount of free space currently in the object store on a Windows Embedded CE–based remote device. |
|
Returns information about the system on a Windows Embedded CE–based remote device. |
|
Retrieves the dimensions of Windows Embedded CE display elements and system configuration settings of a Windows Embedded CE–based remote device. |
|
Retrieves the power status of the system on a Windows Embedded CE–based remote device. |
|
Gets the path to the directory designated for temporary files on a Windows Embedded CE–based remote device. |
|
Obtains extended information about the version of the operating system that is currently running on a Windows Embedded CE–based remote device. |
|
Retrieves the handle to a window that has the specified relationship to the specified window on a Windows Embedded CE–based remote device. |
|
Retrieves information about the specified window on a Windows Embedded CE–based remote device. |
|
Copies the text of the specified window's title bar — if it has one — into a buffer. |
|
Gets information on the physical and virtual memory of the system on a Windows Embedded CE–based remote device. |
|
Issues a mount request on a Windows Embedded CE–based remote device.for a database volume that contains both data and an integrity log. |
|
Renames an existing file or a directory on a Windows Embedded CE–based remote device, including all of its children. |
|
Retrieves information about an object in the object store on a Windows Embedded CE–based remote device. |
|
Retrieves information about an object in the object store or a mounted database volume store on a Windows Embedded CE–based remote device. |
|
Opens an existing database in the object store on a Windows Embedded CE–based remote device. |
|
Opens an existing database in the object store or in a mounted database volume on a Windows Embedded CE–based remote device. |
|
Queries a Windows Embedded CE-based remote device to determine whether it supports the specified processor-specific instruction set. |
|
Frees the memory on the desktop computer allocated by a call to IRAPISession::CeFindAllDatabases, IRAPISession::CeFindAllFiles, or IRAPISession::CeReadRecordProps. |
|
Reports errors that occur during RAPI2 method calls. |
|
Syncronously initializes the communication layers between the desktop and the target Windows Embedded CE-based remote device. |
|
Used as a general-purpose mechanism to remotely execute a routine. |
|
Uninitializes a RAPI2 session. |
|
Reads data from a file on a Windows Embedded CE–based remote device. |
|
Reads properties from the current record of a database on a Windows Embedded CE–based remote device. |
|
Reads properties from the current record of a database on a Windows Embedded CE–based remote device. |
|
Releases the handle of the specified registry key on a Windows Embedded CE–based remote device. |
|
Creates a registry key on a Windows Embedded CE–based remote device. |
|
Deletes a subkey from the specified registry key on a Windows Embedded CE–based remote device. |
|
Removes a value from the specified registry key on a Windows Embedded CE–based remote device. |
|
Enumerates subkeys of an open registry key on a Windows Embedded CE–based remote device. |
|
Enumerates the values for the specified open registry key on a Windows Embedded CE–based remote device. |
|
Opens the specified registry key on a Windows Embedded CE–based remote device. |
|
Retrieves information about a specified registry key on a Windows Embedded CE–based remote device. |
|
Retrieves the type and data for a specified value name associated with an open registry key on a Windows Embedded CE–based remote device. |
|
Stores data in the value field of an open registry key on a Windows Embedded CE–based remote device. |
|
Deletes an existing empty directory on a Windows Embedded CE–based remote device. |
|
Seeks the specified record in an open database on a Windows Embedded CE–based remote device. |
|
Sets parameters for a database in the object store on a Windows Embedded CE–based remote device. |
|
Sets parameters for a database on a Windows Embedded CE–based remote device. |
|
Moves the end-of-file position to the current position of the file pointer for a file on a Windows Embedded CE–based remote device. |
|
Sets the attributes of a file on a Windows Embedded CE–based remote device. |
|
Moves the file pointer of an open file on a Windows Embedded CE–based remote device. |
|
Sets the date and time that a file was created, last accessed, or last modified for files on a Windows Embedded CE–based remote device. |
|
Creates a new shortcut on a Windows Embedded CE–based remote device. |
|
Retrieves the path of the target of a shortcut's target path on a Windows Embedded CE–based remote device. |
|
Begins synchronization between a desktop and a remote Windows Embedded CE–based device. |
|
Stops synchronization between a desktop and a remote Windows Embedded CE–based device. |
|
Unmounts a database volume on a Windows Embedded CE–based remote device. |
|
Writes data to a file on a Windows Embedded CE–based remote device. |
|
Writes a set of properties to a single database record on a Windows Embedded CE–based remote device. |
Requirements
Header | rapi2.h |
Library | ole32.lib, rapiuuid.lib |
Windows Embedded CE | Windows Embedded CE 6.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |