DesktopSDK 0.7 - PenComm Library (C#) Documentation
ContentsIndexHome
Smartpen Members
Smartpen Class  Legend  Public Methods  Public Properties

The following tables list the members exposed by Smartpen.

 
Name 
Description 
 
Aborts immediately any transfers in progress that are using the specified ServiceHandle  
 
Closes a service connection, using a ServiceHandle.  
 
Issue a smartpen command.  
 
Sends commands to the smartpen regarding data of the package specified.
If the package is an AFD, use the "retire" or "deletestrokes" command in your command string. For "deletestrokes", the additional 
 
Deletes strokes from a specific package. Actually, it calls the DataCommand with a command parameter such as: "deletestrokes?copy=1234?page=1234"  
 
Gets data from the specified package and transfers it to the desktop computer in the specified file. You also specify an RTC time indicating a starting point-that is, the earliest data you wish to retrieve. All data created after this time will be returned.
You can retrieve the current RTC time from the smartpen by calling RtcTime or UserTimeGet on the Smartpen object. in order to perform incremental data transfers, you will need to save the current RTC time when you call DataGet method. Then you can use that value the next time you call DataGet.
The progress callback function... more 
 
Retires session data created by Paper Replay. Call this method to delete Paper Replay data (recordings, not strokes) associated with a notebook.  
 
Every time the smartpen is started, the last debug ram is written to the debug ram list. Thus, each debug ram only has information for one smartpen power cycle. Depending on the smartpen model and version, there will be between 4 and 16 debug rams in the debug ram list. As new debug rams are added to the list, the oldest ones are lost. The debug ram list can be retrieved into a file or written to the console using this method. If the debugFile parameter is non-null, then it designates the pathname of the file to which the debug... more 
 
The smartpen keeps a cyclic store of information that may be used to debug problems or monitor pen operation. This is called the debug ram and can hold 65536 bytes of information. As new messages are written, the oldest messages are lost. Packages or pen firmware may write to the debug ram. The debug ram can be retrieved into a file or written to the console via this method. If the fileName parameter is non null, then it designates the pathname of the file into which to write the debug ram; otherwise, the debug ram is written to the system... more 
 
Lists available sessions  
 
Lock 
Acquite exclusive lock on the pen. This will prevent any other application from using the pen until the unlock is called.  
 
Performs a factory reset on the pen. It will remove all penlets, paper products as well as all of package data.  
 
Open 
Allocates a new ServiceHandle to open and keep open a smartpen connection that can be re-used. When you are done with the connection, you must call Smartpen.Close to close the connection and de-allocate the service handle.  
 
Deletes the specified smartpen property.  
 
Gets the property, fills the buf buffer up to the bufSize specified and returns the actual size of the pen property in actualSize.  
 
Sets a customizable smartpen-specific property into the NVRAM of the smartpen.  
 
Restores the pen to factory defaults by removing all strokes, sessions, and package application data (but not un-installed penlets). It also resets all writable pen properties (NVRAM settings).  
 
Gets the absolute (RTC) time from the pen. It is number of milliseconds elapsed since the smartpen was manufactured.  
 
Initializes a new instance of the Smartpen class.  
 
Gets the smartpen state code and, optionally, text explaining the code  
 
Convert the current object to a string  
 
Release exclusive lock on the pen.  
 
Gets the user time from the smartpen as milliseconds since Jan. 1, 1970 (UTC). It can be changed programmatically, as well as by the smartpen user. One overloaded version of this method passes back the current RTC time.  
 
Sets the user clock on the smartpen. The user time offset (userTime) is the number of milliseconds since 1/1/1970 (UTC). The rtcTime parameter is used to calculate an additional offset to take into account the time between calling the RtcTime() function and calling this function.  
 
Get the wedding ring pen property.  
 
Sets the wedding ring property.  
 
Name 
Description 
 
Gets the SmartpenChangeListobject for this smartpen  
 
Gets the SmartpenHardware object for this smartpen  
 
Gets the SmartpenPackages object for this smartpen  
 
Property to get or set the smartpen handle (See PenHandle.) Setting the PenHandle allocates new hardware, package, and changelist objects for the new handle.  
 
Gets the unique smartpen identifier for this smartpen. It is a 64-bit number. See PenAPI.PenId  
 
Gets the pen serial for this smartpen. It is the Pen ID in string format. See PenAPI.PenId  
 
Gets the PenTypeInfo object for the smartpen, consisting of major type and minor type. For available constants, see PenAPI.PenTypeTypes.  
 
Gets the PenTypeInfo as a string. For available constants, see PenAPI.PenTypeTypes  
 
Tag 
User property tag, which can be employed for any purpose.  
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at support@toolsfactory.com.
Copyright © 2010 Livescribe, Inc. All rights reserved.