Properties and Functions of Top Sync generic Conduit:
F:Function P:Property E:Event
| Name | Type | Description |
Returns |
| EVENTS | |||
| HSyncStart(HotsyncUserName, HotsyncUserID , UserLocalPath , SyncType, CancelSync) | E | This event notifies that a palm wants to
sync with our conduit HotsyncUserName, HotsyncUserID , UserLocalPath , SyncType are the information about the PALM/USER CancelSync is for not accepting the connection if set to true SyncType Can be S_PC=1 < PC Syncs the first time S_HH=2 < PALM Syncs the first time S_Neither=0 |
|
| HSyncWantsCommand() | E | This event notifies that The Command queue is empty, if no new command is given then conduit will finish the session | |
| HSyncCompletedCommand(CommandType , CommandText, ReturnParameter, ErrorState , ErrorText ) | E | This event fires after each completed command. if errors happened during the execution then the ErrorState will hold the error number and ErrorText the description CommandType - is the type of the command executed ReturnParameter - if the command must return a parameter then this value will have it Like Command : C_GetPalmDateTime >> will return the palm date in ReturnParameter C_GetFileinfo >>will return PalmRootDir & "PdaGenFI.TXT" in ReturnParameter |
|
| HSyncEnd() | E | This event fires after the Palm Hotsync Session endet | |
| FUNCTIONS | |||
| C_ClearCommandList() | F | Clears the Command queue of the Conduit | 0 or Error |
| C_DeleteFile(PalmFile As String) | F | Deletes The File From HandHeld (PalmFile
=exact Name of the palm file) attention: AddresDB.pdb is not the same as addresdb.pdb |
0 or Error |
| C_EndSync([ForceNow As Integer]) | F | Terminates the Sync Session(immediatly if ForceNow<>0) | 0 or Error |
| C_GetFileFromPalm(File_Name As String) | F | Gets The File form Handheld (File_Name must
have the exact path + palm filename
) example :C_GetFileFromPalm("C:\INBOX\AddresDB.pdb") |
0 or Error |
| C_GetFileinfo(PalmFile As String) | F | Returns the Palm File info in HSyncCompletedCommand
event (returns a txt filename in ReturnParameter
- PalmRootDir & "PdaGenFI.TXT )
>Format of the file is: "PdbName|CreatorID|DbType|Version|CreateDate|ModDate|BackupDate|DbFlags|RecordCount|TotalBytes|AppInfoSize|SortInfoSize" |
0 or Error |
| C_GetPalmDateTime() | F | Returns the Palm Date-time info in HSyncCompletedCommand event (returns the date in ReturnParameter) | 0 or Error |
| C_GetPalmDir (RAM_ROM) | F | Returns the Palm Directory List in HSyncCompletedCommand
event (returns a txt filename in ReturnParameter) >Format of the file is: "DBname|CreatorID|DbType|DbFlags|RecordCount" RAM_ROM parameter is: 0 for ROM DBList And 1 For RAMDBList |
0 or Error |
| C_GetPalmInfo() | F | Returns the Palm nfo in HSyncCompletedCommand
event (returns a txt filename in ReturnParameter) >Format of the file is: "PALMOSVe|SyncManageVe|SysDateTime|ProductID|RomOsVersion|Mem.Card|Mem.Size|FreeRam|RAMDBCount|ROMSize|ROMDBCount" |
0 or Error |
| C_GetPalmUsers() | F | returns a txt filename that has all the Palm
Users >Format of the file is: UserID|UserName|LocalPath" |
|
| C_SendFileToPalm(File_Name) | F | Sends a file to palm (pdb,prc,pqa). exact
name and path C_SendFileToPalm("C:\MYDATA\AAA.PDB") |
0 or Error |
| C_SetPalmDate(Year, Month,day,hour, Minute) | F | Sets The Date Time of the Connected palm
C_SetPalmDate(2002, 10,25,14, 38) |
0 or Error |
| C_Wait(Seconds) | F | The Conduit Idles Seconds , Like this without
blocking the conduit you can do other
operations. C_Wait(60) - will let you work without canceling the sync for 60 secs. and will return with HSyncWantsCommand() after 60 secs. |
0 or Error |
| C_WaitCancel() | F | Cancels the wait Operation ( If you give
a wait(60) and after 30 seconds want to continue
then example: C_WaitCancel() C_GetPalmInfo() >>< this will cancel the waiting and will process the palmInfo command |
0 or Error |
| Z_ChangeMainCreatorForConduit(NewCreatorID , MagicNumber ) | F | Normally you don't need this function but
if you want to assign another Creator
ID
For the conduit then You can change
it. MagicNumber must be -1453 Z_ChangeMainCreatorForConduit("AABC" , -1453 ) will change the Creator ID of the main Conduit. !!! But Attention >> If the connected Palm Does Not Have A PDB-PRC Having this creator ID Then Your Conduit will never Sync Again !! |
|
| Properties | |||
| R: Read Only | |||
| ConduitCreatorID | P(R) | Returns The Valid Creator ID Of the Conduit | |
| Info | P(R) | Returns The Info Of the Activex Programmer-Company-webSite | |
| LastError | P(R) | Returns The Last Error Number | |
| LastErrorText | P(R) | Returns The description Of the Last Error | |
| MaxPdbSize | P | Sets - Returns the Maximum Size Of the Pdb That will be handled with the conduit 1,000,000 to 10,000,000 Bytes | |
| P_UserID , P_UserName , P_UserPath , PalmRootDir | P(R) | Returns The Information About the connected user-Palm | |
| Priority | P | Sets - Returns the priority Of the Activex
(if there is a few activex'es that
are used
the the higher priority will get the
control
first) VeryHigh=2 High=1 Normal=0 |
|
| StopWatch | P(R) | Gives the time Passed in seconds for each
Command executed if used during HSyncCompletedCommand() event then will return the elapsed seconds of the executed Command |
|
| QuickGet | P | Sets - Returns The Type of transport of the
files From Palm To PC 0:CompressedFlatFile - Fastest 1:FlatFile - Fast ( Needs 2*PDB Ram size) 2:NoQuickGet - Slow |
|
| QuickSend | P | Sets - Returns The Type of transport of the
files From PC To PALM 0:CompressedFileSendNowUnzipLater- Fastest 2:CompressedFileSendUnzipLater-Fast 1-CompressedFileSendNowUnzipNow-Slow 3-OnlyFileSendLater-Slowest |
|
| Activex Enums | |||
| P_QuickSend | CompressedFileSendNowUnzipLater = 0 CompressedFileSendNowUnzipNow=1 CompressedFileSendUnzipLater=2 OnlyFileSendLater=3 |
||
| P_QuickGet | CompressedFlatFile = 0 FlatFile=1 NoQuickGet=2 |
||
| C_CommandType | CT_ClearCommandList = 0 CT_DeleteFile=1 CT_EndSync=2 CT_GetFileFromPalm=3 CT_GetFileinfo=4 CT_GetPalmDir=5 CT_GetPalmInfo=6 CT_GetPalmUsers=7 CT_SendFileToPalm=8 CT_Wait=10 CT_SetPalmDate=11 CT_GetPalmDate=12 |
||
| E_ConduitErrors | Noerror = 0 NoHotSyncSessionActive=1 SyntaxError=2 File_Path_Error=3 NotPalmFile=4 OnlyPdbwithoutQuickMode=5 TimeError=6 |
||
| S_FirstSync | S_Neither = 0 S_PC=1 S_HH=2 |
||