PTRobot API
Page 2 of 41
© 2005, Primera Technology, Inc. Primera is a registered trademark and Bravo is a trademark of Primera Technology, Inc. All other trademarks are the property of
their respective companies.
1 PTRobot
Description ...................................................................................................................................... 5
1.1 Description.............................................................................................................................................. 5
1.2 Usage....................................................................................................................................................... 5
2 API
Functions ................................................................................................................................................. 7
2.1
PTRobot Setup Functions ....................................................................................................................... 7
2.1.1 PTRobot_Initialize.......................................................................................................................... 7
2.1.2 PTRobot_Destroy ........................................................................................................................... 7
2.1.3 PTRobot_SetupDebugging ............................................................................................................. 7
2.1.4 PTRobot_EnumRobots ................................................................................................................... 8
2.1.5 PTRobot_EnumDrives.................................................................................................................... 9
2.1.6 PTRobot_EnumDrivesWithList.................................................................................................... 10
2.1.7 PTRobot_SetRoboticDrive ........................................................................................................... 11
2.1.8 PTRobot_SetOpenCloseFunction ................................................................................................. 11
2.1.9 PTRobot_SetRobotOptions........................................................................................................... 12
2.1.10 PTRobot_GetRobotOptions.......................................................................................................... 12
2.1.11 PTRobot_GetErrorString .............................................................................................................. 13
2.1.12 PTRobot_SetApplicationID.......................................................................................................... 14
2.2
PTRobot Info/Status Functions............................................................................................................. 14
2.2.1 PTRobot_GetDriveInfo................................................................................................................. 14
2.2.2 PTRobot_GetRobotInfo................................................................................................................ 14
2.2.3 PTRobot_GetRobotStatus............................................................................................................. 15
2.2.4 PTRobot_GetMediaInfo ............................................................................................................... 15
2.3
PTRobot Robotic Functions.................................................................................................................. 17
2.3.1 PTRobot_LoadDrive..................................................................................................................... 17
2.3.2 PTRobot_LoadPrinter ................................................................................................................... 17
2.3.3 PTRobot_LoadPrinterFromDrive ................................................................................................. 18
2.3.4 PTRobot_UnLoadDrive................................................................................................................ 18
2.3.5 PTRobot_UnLoadPrinter .............................................................................................................. 19
2.3.6 PTRobot_MoveDiscBetweenLocations........................................................................................ 19
2.3.7 PTRobot_PrintFile ........................................................................................................................ 20
2.3.8 PTRobot_PrintFileWithMerge...................................................................................................... 21
2.3.9 PTRobot_SetPrinterSettings ......................................................................................................... 21
2.3.10 PTRobot_GetPrinterSettings......................................................................................................... 22
2.3.11 PTRobot_KillSystemError............................................................................................................ 22
2.3.12 PTRobot_SystemAction ............................................................................................................... 23
2.3.13 PTRobot_OpenCloseDrive ........................................................................................................... 24
3 Type
Definitions ........................................................................................................................................... 25
3.1 PTDriveInfo
Structure .......................................................................................................................... 25
3.2 PTRobotInfo
Structure.......................................................................................................................... 25
3.3 PTRobotStatus
Structure....................................................................................................................... 25
3.4 PTPrinterSettings
Structure .................................................................................................................. 26
3.5 PTMediaInfo
Structure ......................................................................................................................... 26
4 Definitions..................................................................................................................................................... 28
4.1
API Return Values ................................................................................................................................ 28
4.2 System
Errors........................................................................................................................................ 28