DesktopSDK 0.7 - PenComm Library (C#) Documentation
Contents
Overview
Design
Guidelines
Classes
Pen Communication
Smartpens Class
Smartpens Members
Smartpens Constructor
Smartpens.Smartpens Constructor ()
Smartpens.Smartpens Constructor (bool, string)
Smartpens.Smartpens Constructor (bool, string, bool)
Smartpens Methods
Smartpens.ConfigureLogging Method
Smartpens.Destroy Method
Smartpens.Find Method
GetPen Method
Smartpens.GetPen Method (PenHandle)
Smartpens.GetPen Method (UInt64)
Initialize Method
Smartpens.Initialize Method ()
Smartpens.LogEvent Method
Smartpens.Version Method
Smartpens.VersionService Method
Smartpens Properties
Smartpens.DesktopApplications Property
Smartpens.PenCount Property
Smartpens.PenHandles Property
Smartpens.Pens Property
Smartpens Delegates
Smartpens.SmartpenChangeCallback Delegate
Smartpens Events
Smartpens.SmartpenAttachDfuEvent Event
Smartpens.SmartpenAttachNormalEvent Event
Smartpens.SmartpenDetachDfuEvent Event
Smartpens.SmartpenDetachNormalEvent Event
Smartpens.SmartpenDetachUnknownEvent Event
Smartpen Class
Smartpen Members
Smartpen Constructor
Smartpen.Smartpen Constructor ()
Smartpen.Smartpen Constructor (PenHandle)
Smartpen Methods
Smartpen.Abort Method
Smartpen.Close Method
Command Method
Smartpen.Command Method (string)
Smartpen.Command Method (string, string)
Smartpen.Command Method (string, string, ServiceHandle)
DataCommand Method
Smartpen.DataCommand Method (string, string)
Smartpen.DataCommand Method (string, string, PenAPI.PackageCommandCallback)
Smartpen.DataCommand Method (string, string, PenAPI.PackageCommandCallback, PenAPI.ProgressCallback, object)
Smartpen.DataCommand Method (string, string, PenAPI.PackageCommandCallback, PenAPI.ProgressCallback, object, ServiceHandle)
Smartpen.DataCommand Method (string, string, out string)
DataDeleteStrokes Method
Smartpen.DataDeleteStrokes Method (string, int, int)
Smartpen.DataDeleteStrokes Method (string, int, int, ServiceHandle)
DataGet Method
Smartpen.DataGet Method (string, UInt64, string)
Smartpen.DataGet Method (string, UInt64, string, PenAPI.ProgressCallback, object)
Smartpen.DataGet Method (string, UInt64, string, PenAPI.ProgressCallback, object, string)
Smartpen.DataGet Method (string, UInt64, string, PenAPI.ProgressCallback, object, string, ServiceHandle)
DataRetire Method
Smartpen.DataRetire Method (string, bool)
Smartpen.DataRetire Method (string, bool, ServiceHandle)
DebugList Method
Smartpen.DebugList Method (string)
Smartpen.DebugList Method (string, ServiceHandle)
DebugRam Method
Smartpen.DebugRam Method (string, bool)
Smartpen.DebugRam Method (string, bool, ServiceHandle)
ListSessions Method
Smartpen.ListSessions Method ()
Smartpen.ListSessions Method (PenAPI.ProgressCallback, object)
Smartpen.ListSessions Method (PenAPI.ProgressCallback, object, ServiceHandle)
Smartpen.Lock Method
MasterReset Method
Smartpen.MasterReset Method ()
Smartpen.MasterReset Method (ServiceHandle)
Open Method
Smartpen.Open Method ()
Smartpen.Open Method (UInt32)
PropertyDelete Method
Smartpen.PropertyDelete Method (Int32)
Smartpen.PropertyDelete Method (Int32, ServiceHandle)
Smartpen.PropertyDelete Method (PenAPI.PenPropertyKeys)
Smartpen.PropertyDelete Method (PenAPI.PenPropertyKeys, ServiceHandle)
PropertyGet Method
Smartpen.PropertyGet Method (Int32, out byte[])
Smartpen.PropertyGet Method (Int32, out byte[], ServiceHandle)
Smartpen.PropertyGet Method (Int32, out string, out int)
Smartpen.PropertyGet Method (Int32, out string, out int, ServiceHandle)
Smartpen.PropertyGet Method (PenAPI.PenPropertyKeys, out byte[])
Smartpen.PropertyGet Method (PenAPI.PenPropertyKeys, out byte[], ServiceHandle)
Smartpen.PropertyGet Method (PenAPI.PenPropertyKeys, out string, out int)
Smartpen.PropertyGet Method (PenAPI.PenPropertyKeys, out string, out int, ServiceHandle)
PropertySet Method
Smartpen.PropertySet Method (Int32, byte [])
Smartpen.PropertySet Method (Int32, byte [], ServiceHandle)
Smartpen.PropertySet Method (Int32, string)
Smartpen.PropertySet Method (Int32, string, ServiceHandle)
Smartpen.PropertySet Method (PenAPI.PenPropertyKeys, byte [])
Smartpen.PropertySet Method (PenAPI.PenPropertyKeys, byte [], ServiceHandle)
Smartpen.PropertySet Method (PenAPI.PenPropertyKeys, string)
Smartpen.PropertySet Method (PenAPI.PenPropertyKeys, string, ServiceHandle)
RemoveUserData Method
Smartpen.RemoveUserData Method ()
Smartpen.RemoveUserData Method (ServiceHandle)
RtcTime Method
Smartpen.RtcTime Method ()
Smartpen.RtcTime Method (ServiceHandle)
State Method
Smartpen.State Method ()
Smartpen.State Method (out string)
Smartpen.ToString Method
Smartpen.UnLock Method
UserTimeGet Method
Smartpen.UserTimeGet Method ()
Smartpen.UserTimeGet Method (out UInt64)
Smartpen.UserTimeGet Method (out UInt64, ServiceHandle)
UserTimeSet Method
Smartpen.UserTimeSet Method (UInt64)
Smartpen.UserTimeSet Method (UInt64, UInt64)
Smartpen.UserTimeSet Method (UInt64, UInt64, ServiceHandle)
WeddingRingGet Method
Smartpen.WeddingRingGet Method ()
Smartpen.WeddingRingGet Method (ServiceHandle)
WeddingRingSet Method
Smartpen.WeddingRingSet Method (string)
Smartpen.WeddingRingSet Method (string, ServiceHandle)
Smartpen Properties
Smartpen.ChangeList Property
Smartpen.Hardware Property
Smartpen.Packages Property
Smartpen.PenHandle Property
Smartpen.PenID Property
Smartpen.PenSerial Property
Smartpen.PenType Property
Smartpen.PenTypeText Property
Smartpen.Tag Property
SmartpenHardware Class
SmartpenHardware Members
SmartpenHardware Constructor
SmartpenHardware.SmartpenHardware Constructor ()
SmartpenHardware.SmartpenHardware Constructor (PenHandle)
SmartpenHardware Methods
SmartpenHardware.Equals Method
SmartpenHardware.SoftwareVersion Method
SmartpenHardware.ToString Method
Update Method
SmartpenHardware.Update Method ()
SmartpenHardware.Update Method (PenAPI.ProgressCallback, object)
SmartpenHardware.Update Method (PenAPI.ProgressCallback, object, ServiceHandle)
SmartpenHardware Properties
SmartpenHardware.Battery Property
SmartpenHardware.BatteryLevel Property
SmartpenHardware.BatteryTemperature Property
SmartpenHardware.BatteryVoltage Property
SmartpenHardware.BootloaderSvnRev Property
SmartpenHardware.Memory Property
SmartpenHardware.MemoryApplication Property
SmartpenHardware.MemoryFiles Property
SmartpenHardware.MemoryFree Property
SmartpenHardware.MemorySystem Property
SmartpenHardware.MemoryTotal Property
SmartpenHardware.PenHandle Property
SmartpenHardware.PenID Property
SmartpenHardware.PenSerial Property
SmartpenHardware.PenSize Property
SmartpenHardware.PenType Property
SmartpenHardware.PenTypeText Property
SmartpenHardware.SoftwareModified Property
SmartpenHardware.SoftwareRev Property
SmartpenHardware.SoftwareSvnBranch Property
SmartpenHardware.SoftwareSvnRev Property
SmartpenHardware.Version Property
SmartpenPackages Class
SmartpenPackages Members
SmartpenPackages Constructor
SmartpenPackages.SmartpenPackages Constructor ()
SmartpenPackages.SmartpenPackages Constructor (PenHandle)
SmartpenPackages Methods
SmartpenPackages.GetPaperReplay Method
SmartpenPackages.IsPackageInstalled Method
SmartpenPackages.Refresh Method
SetAttribs Method
SmartpenPackages.SetAttribs Method (ServiceHandle, string, PackageAttribPairs)
SmartpenPackages.ToString Method
Update Method
SmartpenPackages.Update Method ()
SmartpenPackages Properties
SmartpenPackages.Count Property
SmartpenPackages.Items Property
SmartpenPackages.PenHandle Property
SmartpenChangeList Class
SmartpenChangeList Members
SmartpenChangeList Constructor
SmartpenChangeList.SmartpenChangeList Constructor ()
SmartpenChangeList.SmartpenChangeList Constructor (PenHandle)
SmartpenChangeList Methods
SmartpenChangeList.ToString Method
Update Method
SmartpenChangeList.Update Method (UInt64)
SmartpenChangeList.Update Method (UInt64, PenAPI.ProgressCallback, object)
SmartpenChangeList.Update Method (UInt64, PenAPI.ProgressCallback, object, ServiceHandle)
SmartpenChangeList Properties
SmartpenChangeList.ChangeItemCount Property
SmartpenChangeList.ChangeItems Property
SmartpenChangeList.PenHandle Property
SmartpenChangeList.StartTime Property
ApplicationManagement Class
ApplicationManagement Members
ApplicationManagement.ApplicationManagement Constructor
ApplicationManagement Classes
ApplicationManagement.RegAppInfoItem Class
RegAppInfoItem Members
ApplicationManagement.RegAppInfoItem.RegAppInfoItem Constructor
RegAppInfoItem Properties
ApplicationManagement.RegAppInfoItem.AppInfo Property
ApplicationManagement.RegAppInfoItem.Handle Property
ApplicationManagement.RegPackageInfoItem Class
RegPackageInfoItem Members
ApplicationManagement.RegPackageInfoItem.RegPackageInfoItem Constructor
RegPackageInfoItem Properties
ApplicationManagement.RegPackageInfoItem.Handle Property
ApplicationManagement.RegPackageInfoItem.PackageInfo Property
ApplicationManagement Methods
ApplicationManagement.GetAutoLaunch Method
ApplicationManagement.GetRegisteredApp Method
ApplicationManagement.GetRegisteredAppList Method
ApplicationManagement.GetRegisteredPackage Method
ApplicationManagement.GetRegisteredPackageList Method
ApplicationManagement.RegisterApp Method
ApplicationManagement.RegisterDataCallback Method
ApplicationManagement.RegisterPackage Method
ApplicationManagement.SetAutoLaunch Method
ApplicationManagement.SetAutoStartPens Method
ApplicationManagement.SetRegisteredApp Method
ApplicationManagement.UnRegisterApp Method
ApplicationManagement.UnRegisterPackage Method
Types
PenDataCallbackInfo Class
PenDataCallbackInfo Members
PenDataCallbackInfo Fields
PenDataCallbackInfo.buffer Field
PenDataCallbackInfo.bufSize Field
PenDataCallbackInfo.packageHandle Field
PenDataCallbackInfo.packetStatus Field
PenDataCallbackInfo.penId Field
PenDataCallbackInfo.pos Field
PenDataCallbackInfo.startRtc Field
PenDataCallbackInfo.total Field
AppHandle Structure
AppHandle Members
AppHandle Methods
AppHandle.Equals Method
AppHandle.GetHashCode Method
AppHandle.ToString Method
AppHandle.Zero Method
AppHandle Operators
AppHandle.!= Operator
AppHandle.== Operator
AppHandle.AppHandle Operator
AppHandle.int Operator
PenHandle Structure
PenHandle Members
PenHandle Methods
PenHandle.Equals Method
PenHandle.GetHashCode Method
PenHandle.ToString Method
PenHandle.Zero Method
PenHandle Operators
PenHandle.!= Operator
PenHandle.== Operator
PenHandle.int Operator
PenHandle.PenHandle Operator
ServiceHandle Structure
ServiceHandle Members
ServiceHandle Methods
ServiceHandle.Equals Method
ServiceHandle.GetHashCode Method
ServiceHandle.ToString Method
ServiceHandle.Zero Method
ServiceHandle Operators
ServiceHandle.!= Operator
ServiceHandle.== Operator
ServiceHandle.int Operator
ServiceHandle.ServiceHandle Operator
PenId Structure
PenId Members
PenId Methods
PenId.Equals Method
PenId.GetHashCode Method
PenId.ToString Method
PenId.Zero Method
PenId Operators
PenId.!= Operator
PenId.== Operator
PenId.PenId Operator
PenId.UInt64 Operator
PackageHandle Structure
PackageHandle Members
PackageHandle Methods
PackageHandle.Equals Method
PackageHandle.GetHashCode Method
PackageHandle.ToString Method
PackageHandle.Zero Method
PackageHandle Operators
PackageHandle.!= Operator
PackageHandle.== Operator
PackageHandle.int Operator
PackageHandle.PackageHandle Operator
SmartpenExceptions Class
SmartpenExceptions Members
SmartpenExceptions Classes
SmartpenExceptions.SdkAPIException Class
SdkAPIException Members
SmartpenExceptions.SdkAPIException.SdkAPIException Constructor
SmartpenExceptions.SdkConnectionIOError Class
SdkConnectionIOError Members
SdkConnectionIOError Constructor
SmartpenExceptions.SdkConnectionIOError.SdkConnectionIOError Constructor ()
SmartpenExceptions.SdkConnectionIOError.SdkConnectionIOError Constructor (string)
SmartpenExceptions.SdkConnectionNotOpen Class
SdkConnectionNotOpen Members
SdkConnectionNotOpen Constructor
SmartpenExceptions.SdkConnectionNotOpen.SdkConnectionNotOpen Constructor ()
SmartpenExceptions.SdkConnectionNotOpen.SdkConnectionNotOpen Constructor (string)
SmartpenExceptions.SdkFileError Class
SdkFileError Members
SdkFileError Constructor
SmartpenExceptions.SdkFileError.SdkFileError Constructor ()
SmartpenExceptions.SdkFileError.SdkFileError Constructor (string)
SmartpenExceptions.SdkFileError.SdkFileError Constructor (string, string)
SmartpenExceptions.SdkFirmwareError Class
SdkFirmwareError Members
SdkFirmwareError Constructor
SmartpenExceptions.SdkFirmwareError.SdkFirmwareError Constructor ()
SmartpenExceptions.SdkFirmwareError.SdkFirmwareError Constructor (string)
SmartpenExceptions.SdkGenericIOError Class
SdkGenericIOError Members
SdkGenericIOError Constructor
SmartpenExceptions.SdkGenericIOError.SdkGenericIOError Constructor ()
SmartpenExceptions.SdkGenericIOError.SdkGenericIOError Constructor (string)
SmartpenExceptions.SdkIllegalArgument Class
SdkIllegalArgument Members
SdkIllegalArgument Constructor
SmartpenExceptions.SdkIllegalArgument.SdkIllegalArgument Constructor ()
SmartpenExceptions.SdkIllegalArgument.SdkIllegalArgument Constructor (string)
SmartpenExceptions.SdkOutOfMemory Class
SdkOutOfMemory Members
SdkOutOfMemory Constructor
SmartpenExceptions.SdkOutOfMemory.SdkOutOfMemory Constructor ()
SmartpenExceptions.SdkOutOfMemory.SdkOutOfMemory Constructor (string)
SmartpenExceptions.SdkParseError Class
SdkParseError Members
SdkParseError Constructor
SmartpenExceptions.SdkParseError.SdkParseError Constructor ()
SmartpenExceptions.SdkParseError.SdkParseError Constructor (string)
SmartpenExceptions.SdkPenNotFound Class
SdkPenNotFound Members
SdkPenNotFound Constructor
SmartpenExceptions.SdkPenNotFound.SdkPenNotFound Constructor ()
SmartpenExceptions.SdkPenNotFound.SdkPenNotFound Constructor (string)
SmartpenExceptions.SdkPenOutOfSpace Class
SdkPenOutOfSpace Members
SdkPenOutOfSpace Constructor
SmartpenExceptions.SdkPenOutOfSpace.SdkPenOutOfSpace Constructor ()
SmartpenExceptions.SdkPenOutOfSpace.SdkPenOutOfSpace Constructor (string)
SmartpenExceptions.SdkServiceCmdUnknown Class
SdkServiceCmdUnknown Members
SdkServiceCmdUnknown Constructor
SmartpenExceptions.SdkServiceCmdUnknown.SdkServiceCmdUnknown Constructor ()
SmartpenExceptions.SdkServiceCmdUnknown.SdkServiceCmdUnknown Constructor (string)
SmartpenExceptions.SdkServiceUnavailable Class
SdkServiceUnavailable Members
SdkServiceUnavailable Constructor
SmartpenExceptions.SdkServiceUnavailable.SdkServiceUnavailable Constructor ()
SmartpenExceptions.SdkServiceUnavailable.SdkServiceUnavailable Constructor (string)
SmartpenExceptions.SdkUnexpectedError Class
SdkUnexpectedError Members
SdkUnexpectedError Constructor
SmartpenExceptions.SdkUnexpectedError.SdkUnexpectedError Constructor ()
SmartpenExceptions.SdkUnexpectedError.SdkUnexpectedError Constructor (string)
SmartpenExceptions Methods
SmartpenExceptions.HandleResponse Method
ChangeItem Class
ChangeItem Members
ChangeItem Constructor
ChangeItem.ChangeItem Constructor ()
ChangeItem.ChangeItem Constructor (string, string, string, Int64)
ChangeItem Methods
ChangeItem.AddPage Method
ChangeItem.Equals Method
ChangeItem.ToString Method
ChangeItem Properties
ChangeItem.ClassName Property
ChangeItem.EndTime Property
ChangeItem.Guid Property
ChangeItem.PageCount Property
ChangeItem.Pages Property
ChangeItem.Title Property
PageChangeItem Class
PageChangeItem Members
PageChangeItem Fields
PageChangeItem.Copy Field
PageChangeItem.EndTime Field
PageChangeItem.Page Field
PageChangeItem.PageAddress Field
PackageItem Class
PackageItem Members
PackageItem Methods
PackageItem.Attrib Method
Save Method
PackageItem.Save Method ()
PackageItem.Save Method (ServiceHandle)
PackageItem Properties
PackageItem.CategoryName Property
PackageItem.ClassName Property
PackageItem.FullPath Property
PackageItem.GroupName Property
PackageItem.GroupVersion Property
PackageItem.HighPA Property
PackageItem.Installed Property
PackageItem.Locked Property
PackageItem.LowPA Property
PackageItem.PackageName Property
PackageItem.Private Property
PackageItem.Size Property
PackageItem.Version Property
PenMemoryStatus Class
PenMemoryStatus Members
PenMemoryStatus Fields
PenMemoryStatus.MemoryApplication Field
PenMemoryStatus.MemoryFiles Field
PenMemoryStatus.MemoryFree Field
PenMemoryStatus.MemorySystem Field
PenMemoryStatus.MemoryTotal Field
PenMemoryStatus.PenSize Field
PenVersionInfo Class
PenVersionInfo Members
PenVersionInfo Fields
PenVersionInfo.BootloaderSvnRev Field
PenVersionInfo.SoftwareModified Field
PenVersionInfo.SoftwareRev Field
PenVersionInfo.SoftwareSvnBranch Field
PenVersionInfo.SoftwareSvnRev Field
PenBatteryStatus Class
PenBatteryStatus Members
PenBatteryStatus Fields
PenBatteryStatus.Level Field
PenBatteryStatus.Temperature Field
PenBatteryStatus.Voltage Field
PenTypeInfo Class
PenTypeInfo Members
PenTypeInfo Fields
PenTypeInfo.MajorType Field
PenTypeInfo.MinorType Field
RegAppInfo Class
RegAppInfo Members
RegAppInfo Fields
RegAppInfo.autoStart Field
RegAppInfo.description Field
RegAppInfo.path Field
RegAppInfo.version Field
RegPackageInfo Class
RegPackageInfo Members
RegPackageInfo Fields
RegPackageInfo.appHandle Field
RegPackageInfo.penId Field
RegPackageInfo.uniqueName Field
Callback
PenAPI.DataCallback Delegate
PenAPI.PackageCommandCallback Delegate
PenAPI.ProgressCallback Delegate
Enumerations and Constants
PenAPI Class
PenAPI Members
PenAPI Enumerations
Livescribe.DesktopSDK.PenComm.Interop.PenAPI.AutoStartTypes Enumeration
Livescribe.DesktopSDK.PenComm.Interop.PenAPI.DataOpTypes Enumeration
Livescribe.DesktopSDK.PenComm.Interop.PenAPI.DataPacketStatus Enumeration
Livescribe.DesktopSDK.PenComm.Interop.PenAPI.PackageAttribType Enumeration
Livescribe.DesktopSDK.PenComm.Interop.PenAPI.PenPropertyKeys Enumeration
Livescribe.DesktopSDK.PenComm.Interop.PenAPI.PenResponseCode Enumeration
Livescribe.DesktopSDK.PenComm.Interop.PenAPI.PenStateTypes Enumeration
Livescribe.DesktopSDK.PenComm.Interop.PenAPI.PenTypeTypes Enumeration
PenAPI Fields
PenAPI.DEFAULT_CONNECTION_TIMEOUT Field
PenAPI.MAX_BATTERY_LEVEL_LEN Field
PenAPI.MAX_BATTERY_TEMP_LEN Field
PenAPI.MAX_BATTERY_VOLT_LEN Field
PenAPI.MAX_DESKTOP_APP_DESC Field
PenAPI.MAX_DESKTOP_APP_VER Field
PenAPI.MAX_DESKTOP_META_NAME Field
PenAPI.MAX_DESKTOP_META_SYS_INFO Field
PenAPI.MAX_DESKTOP_META_VER Field
PenAPI.MAX_GUID_LEN Field
PenAPI.MAX_MEMORY_LEN Field
PenAPI.MAX_PACKAGE_ATTRIB_VAL_LEN Field
PenAPI.MAX_PACKAGE_CATEGORY_LEN Field
PenAPI.MAX_PACKAGE_GROUP_LEN Field
PenAPI.MAX_PACKAGE_NAME_LEN Field
PenAPI.MAX_PACKAGE_PATH_LEN Field
PenAPI.MAX_PACKAGE_VERSION_LEN Field
PenAPI.MAX_PATH Field
PenAPI.MAX_PENID_LEN Field
PenAPI.MAX_PENLET_CLASS_LEN Field
PenAPI.MAX_PENS Field
PenAPI.MAX_PENSTATE_LEN Field
PenAPI.MAX_PULSE_VER_LEN Field
PenAPI.MAX_RESPONSETEXT_LEN Field
PenAPI.MAX_TIME_LEN Field
PenAPI.MAX_VERSION_LEN Field
Examples
Get Pen Information Example
User Time Example
Get Set Package Attributes Example
Register Application Example
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
.