Primera Ptrobot api User manual

PTRobot API

DLL Based Application Programming Interface

Primera Technology Inc.

May 16, 2006 / Revision 2.0

PTRobot API Page 2 of 41

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

PTRobot API Page 3 of 41

their respective companies.

4.3 System State.......................................................................................................................................... 29

4.4 Robot Type............................................................................................................................................ 29

4.5 Bin Auto Use......................................................................................................................................... 29

4.6 Robot Options....................................................................................................................................... 30

4.7 Robot Actions ....................................................................................................................................... 30

4.8 Print Quality.......................................................................................................................................... 30

4.9 Drive Open Close.................................................................................................................................. 30

4.10 Locations............................................................................................................................................... 30

4.11 Bus Type............................................................................................................................................... 30

4.12 Clear Drive............................................................................................................................................ 30

4.13 Languages............................................................................................................................................. 31

5 Recommended System Error Strings............................................................................................................ 32

5.1 SYSERR_PTR_TRAY......................................................................................................................... 32

5.2 SYSERR_CART_CODE...................................................................................................................... 32

5.3 SYSERR_INPUT_EMPTY.................................................................................................................. 32

5.4 SYSERR_PTR_COMM ....................................................................................................................... 32

5.5 SYSERR_CLR_EMPTY...................................................................................................................... 32

5.6 SYSERR_BLK_EMPTY...................................................................................................................... 33

5.7 SYSERR_BOTH_EMPTY................................................................................................................... 33

5.8 SYSERR_PICK .................................................................................................................................... 33

5.9 SYSERR_ARM_MOVE....................................................................................................................... 33

5.10 SYSERR_CART_MOVE..................................................................................................................... 34

5.11 SYSERR_INTERNAL_SW ................................................................................................................. 34

5.12 SYSERR_NO_ROBODRIVES............................................................................................................ 34

5.13 SYSERR_OFFLINE............................................................................................................................. 34

5.14 SYSERR_COVER_OPEN ................................................................................................................... 34

5.15 SYSERR_PRINTER_PICK.................................................................................................................. 34

5.16 SYSERR_MULTIPLE_PICK .............................................................................................................. 34

5.17 SYSERR_MULTIPLEDISCS_IN_PRINTER ..................................................................................... 35

5.18 SYSERR_MULTIPLEDISCS_IN_RECORDER................................................................................. 35

5.19 SYSERR_DROPPED_DISC_RECORDER......................................................................................... 35

5.20 SYSERR_DROPPED_DISC_BIN1..................................................................................................... 35

5.21 SYSERR_DROPPED_DISC_BIN2..................................................................................................... 35

5.22 SYSERR_DROPPED_DISC_PRINTER ............................................................................................. 36

5.23 SYSERR_DROPPED_DISC_REJECT................................................................................................ 36

5.24 SYSERR_DROPPED_DISC_UNKNOWN......................................................................................... 36

5.25 SYSERR_ALIGNNEEDED................................................................................................................. 36

5.26 SYSERR_COLOR_INVALID............................................................................................................. 37

5.27 SYSERR_BLACK_INVALID............................................................................................................. 37

5.28 SYSERR_BOTH_INVALID................................................................................................................ 37

5.29 SYSERR_NOCARTS........................................................................................................................... 37

5.30 SYSERR_K_IN_CMY......................................................................................................................... 37

5.31 SYSERR_CMY_IN_K......................................................................................................................... 37

5.32 SYSERR_SWAPPED........................................................................................................................... 37

5.33 SYSERR_PIGONPRO ......................................................................................................................... 38

5.34 SYSERR_ALIGNFAILED................................................................................................................... 38

PTRobot API Page 4 of 41

their respective companies.

5.35 SYSERR_DROPPED_DISC_PRINTER_FATAL............................................................................... 38

5.36 SYSERR_MULTIPLEDISCS_IN_RIGHTBIN................................................................................... 38

5.37 SYSERR_MULTIPLEDISCS_IN_LEFTBIN...................................................................................... 38

5.38 SYSERR_CLR_EMPTY_FINAL ........................................................................................................ 38

5.39 SYSERR_BLK_EMPTY_FINAL........................................................................................................ 39

5.40 SYSERR_BOTH_EMPTY_FINAL..................................................................................................... 39

5.41 SYSERR_WAITING_FOR_PRINTER ............................................................................................... 39

6 Revision History ........................................................................................................................................... 40

PTRobot API Page 5 of 41

their respective companies.

1 PTRobot Description

1.1 Description

PTRobot is an API that allows developers to add robotic support for Primera duplicators to their own Windows

applications. PTRobot consists of several Dynamic Link Libraries (DLLs) that application developers can

utilize to move discs automatically (e.g. move a disc from an input bin into the recorder, etc.) and also provides

the capability to print on the CD/DVD through the Surething CD Labeler application. PTRobot provides an

easy method to create automated CD/DVD printing and/or recording applications (recording capability is not

provided in PTRobot – for recording capability developers should use the PTBurn SDK from Primera).

Currently, PTRobot provides support for the Disc Publisher II, Disc Publisher PRO, Disc Publisher XR, and

Disc Publisher XRP.

1.2 Usage

Below is PSUEDO-CODE example for how a calling application should use PTRobot to

implement robotics into its application.

At program startup:

PTRobot_Initialize(..)

PTRobot_EnumRobots(..)

- if the number of robots is greater than 1 then the calling application will need to

provide some logic/ui to determine which robot to use. The app can use

PTRobot_GetRobotInfo(..) to get details about each robot.

PTRobot_EnumDrives(..) or PTRobot_EnumDrivesWithList(..)

- This will cause PTRobot to determine which drives are robotically controlled by

enumerating the drives themselves (PTRobot_EnumDrives(..)) or based off a list of drives

passed in (PTRobot_EnumDrivesWithList(..))

PTRobot_GetDriveInfo(..) for all drives returned

- This will allow the calling app to know which drive is which

Example a typical job:

PTRobot_LoadDrive(Robot, Drive, TRUE)

- This will load a disc into the drive from the input bin

(should set parameter 3 to TRUE if first round of the job)

PTRobot_GetRobotStatus(..)

- This would be called in a loop until a system error occurred or the system is idle.

…Client application will now perform operations on the disc in the drive (e.g. record on

the disc).

if the operations are successful

PTRobot API Page 6 of 41

their respective companies.

PTRobot_LoadPrinterFromDrive(Robo, Drive)

PTRobot_GetRobotStatus(..) called in a loop

PTRobot_PrintFile(szPrintFile) or PTRobot_PrintFileWithMerge(…)

PTRobot_GetRobotStatus(..) called in a loop

PTRobot_UnloadPrinter(Robot, 0)

PTRobot_GetRobotStatus(..) called in a loop

else

PTRobot_UnloadDrive(Robot, Drive, 100)

PTRobot_GetRobotStatus(..) called in a loop

Before program exit:

PTRobot_Destroy()

PTRobot API Page 7 of 41

their respective companies.

2 API Functions

2.1 PTRobot Setup Functions

2.1.1 PTRobot_Initialize

///////////////////////////

// PTRobot_Initialize

// Description:

// Function to initialize internal data structures of

// the PTRobot module.

// Params:

// None

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_INTERNAL if an internal error occurred.

///////////////////////////

DWORD WINAPI PTRobot_Initialize();

2.1.2 PTRobot_Destroy

///////////////////////////

// PTRobot_Destroy

// Description:

// Function to destroy internal data structures of

// the PTRobot module.

// Params:

// None

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

///////////////////////////

DWORD WINAPI PTRobot_Destroy();

2.1.3 PTRobot_SetupDebugging

///////////////////////////

// PTRobot_SetupDebugging

// Description:

PTRobot API Page 8 of 41

their respective companies.

// Function to setup logging in the PTRobot module. We advise that your

// application has a "back door" method of turning debugging on. All debugging

// is off by default.

// Params:

// szDbgFile full path to a debug file

// dwDbgLvl debug Level (0-5)

// 0 = off, 1 = errors, 2 = warnings

// 3 = Info, 4 and 5 = more info

// szTraceFile full path to a trace file

// Notes:

// If szDbgFile is NULL then debugging will be turned off. If szTraceFile is

// NULL then function tracing will be off. Function tracing just logs the

// API function calls including the parameters.

// Return:

// PTROBOT_OK if Successful

// PTROBOT_INTERNAL if an internal error occurred

///////////////////////////

DWORD WINAPI PTRobot_SetupDebugging(TCHAR *szDbgFile, DWORD dwDbgLvl, TCHAR *

szTraceFile);

2.1.4 PTRobot_EnumRobots

///////////////////////////

// PTRobot_EnumRobots

// Description:

// Function to enumerate the Robots on the system.

// Params:

// phRobots points to an array of HANDLEs to store

// the Robots found.

// pdwNumRobots points to a DWORD containing the number of HANDLEs

// in the phRobots array. This value is an input

// and an output. The user should specify the size

// (number of HANDLEs) of the phRobots array on input.

// The value of the pdwNumRobots on output will be the

// number of robots found.

// Notes:

// Both params will be updated upon successful completion of this

// command. phRobots will contain handles to robots connected to

// this system. pdwNumRobots will will be updated with the number of

// robots found.

// Also, note that the hDrives[] array in the PTRobotInfo will not be

// valid until PTRobot_EnumDrives is called.

// Return:

// PTROBOT_OK if Successful

// PTROBOT_INVALID_ROBOT if no robots found

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_OVERFLOW if the number of robots found is > the value in

PTRobot API Page 9 of 41

their respective companies.

// pdwNumRobots

///////////////////////////

DWORD WINAPI PTRobot_EnumRobots(HANDLE *phRobots, DWORD *pdwNumRobots);

2.1.5 PTRobot_EnumDrives

///////////////////////////

// PTRobot_EnumDrives

// Description:

// Function to enumerate the drives on the system and

// determine which drives are under the control of this

// robot.

// Params:

// hRobot Handle to the robot to enumerate the drives of.

// phDrives points to an array of DWORDS to store

// the Drives found.

// pdwNumDrives points to a DWORD containing the number of HANDLEs

// in the phDrives array. This value is an input

// and an output. The user should specify the size

// (number of HANDLEs) of the phDrives array on input.

// The value of the pdwNumDrives on output will be the

// number of drives found.

// Notes:

// Both params will be updated upon successful completion of this

// command. phDrives will contain handles to drives connected to

// this system. pdwNumDrives will will be updated with the number of

// drives found.

// The format of the drive handles is the following:

// The least significant byte should contain the drive letter, the

// other three bytes should contain the SCSI triple.

// The drive can be identified by either of these methods.

// For Example: 0x01030044 would identify a drive with:

// Host=1, ID = 3, LUN = 0, and a drive letter of "D"

// To identify the same drive the client could pass

// down 0x01030000, 0x00000044, or 0x01030044.

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence or after

// PTRobot_EnumDrivesWithList

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_OVERFLOW if the number of drives found is > the value in

// pdwNumDrives

// PTROBOT_MULTDRIVES if the module cannot determine which drives are

PTRobot API Page 10 of 41

their respective companies.

// robotically controlled. The calling application

// needs to use PTRobot_SetRoboticDrive to resolve

// this error.

///////////////////////////

DWORD WINAPI PTRobot_EnumDrives(HANDLE hRobot, HANDLE *phDrives, DWORD *pdwNumDrives);

2.1.6 PTRobot_EnumDrivesWithList

///////////////////////////

// PTRobot_EnumDrivesWithList

// Description:

// Function to pass down drives enumerated by the calling app for

// PTRobot to use in determining which drives are robotically controlled.

// This is an alternative function to PTRobot_EnumDrives.

// Params:

// hRobot Handle to the robot.

// phDrives points to an array of HANDLEs that contains the

// drive handles of the drives in the system

// pdwNumDrives points to a DWORD containing the number of HANDLEs

// in the phDrives array.

// phRobotDrives points to an array of HANDLEs that contains the

// drive handles of the drives contained in this robot.

// pdwNumRobotDrives points to a DWORD containing the number of drives

// in the phRobotDrives array.

// Notes:

// phRobotDrives and pdwNumRobotDrives will be updated upon successful

// completion of this command. phRobotDrives will contain

// handles to drives contained in the robot. pdwNumRobotDrives will be

// updated with the number of drives found.

// The format of the drive handle is the following:

// The least significant byte should contain the drive letter, the

// other three bytes should contain the SCSI triple. The drive can

// be identified by either of these methods.

// For Example: 0x01030044 would identify a drive with:

// Host=1, ID = 3, LUN = 0, and a drive letter of "D"

// To identify the same drive the client could pass down

// 0x01030000, 0x00000044, or 0x01030044.

// This function should be called instead of PTRobot_EnumDrives if the

// calling application wants to enumerate the drives and have PTRobot

// select the Robotically controlled drives from the list the calling

// application provides.

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence or after

// PTRobot_EnumDrives

PTRobot API Page 11 of 41

their respective companies.

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_OVERFLOW if the number of robotic drives found is > the value

// in pdwDrives

// PTROBOT_MULTDRIVES if the module cannot determine which drives are

// robotically controlled.

///////////////////////////

DWORD WINAPI PTRobot_EnumDrivesWithList(HANDLE hRobot, HANDLE *phDrives,

DWORD *pdwNumDrives, HANDLE *phRobotDrives, DWORD *

pdwNumRobotDrives);

2.1.7 PTRobot_SetRoboticDrive

///////////////////////////

// PTRobot_SetRoboticDrive

// Description:

// Function to set a drive's position within the duplicator when

// the PTROBOT_MULTDRIVES error is returned from either of the

// EnumDrives functions.

// Params:

// hRobots Handle to the Robot.

// hDrive Handle to the Drive

// dwColIndex Index identifying the column that the drive is in.

// (0 based where 0 is the left-most column)

// dwRowIndex Index identifying the row that the drive is in.

// (0 based where 0 is the top row)

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_INVALID_DRIVE if the drive handle is invalid

// PTROBOT_INVALID_DRIVE_POSITION if column/row ids are invalid.

///////////////////////////

DWORD WINAPI PTRobot_SetRoboticDrive(HANDLE hRobot, HANDLE hDrive, DWORD dwColIndex,

DWORD dwRowIndex);

2.1.8 PTRobot_SetOpenCloseFunction

///////////////////////////

// PTRobot_SetOpenCloseFunction

// Description:

// Function to set a calling application provided drive open/close

// function.

// Params:

PTRobot API Page 12 of 41

their respective companies.

// pvOpenClose pointer to a function to open and close the drive.

// (setting to NULL will cause non-callback open/close

// to be used).

// Notes:

// This function allows the calling application to provide the drive

// open/closing functionality through their recording engine. If this

// function is not called then the drive will be opened/closed via OS

// calls. The function pointed to by the pvOpenClose param should be

// defined as follows:

// void OpenCloseDrive(DWORD hDrive, DWORD dwOpen);

// Please see the "Drive Open/Close" definitions above for the dwOpen

// param.

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

///////////////////////////

DWORD WINAPI PTRobot_SetOpenCloseFunction(void *pvOpenClose);

2.1.9 PTRobot_SetRobotOptions

///////////////////////////

// PTRobot_SetRobotOptions

// Description:

// Function to set the current robot options.

// Params:

// hRobot Handle to the robot

// dwRobotOptions DWORD containing the options to set.

// See

"Robot Options" defines above

// Notes:

// You should call PTRobot_GetRobotOptions to get the current Options

// and then set the options you want to change prior to calling

// this function.

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_UNSUPPORTED_OPTION if the option is unsupported on that robot

///////////////////////////

DWORD WINAPI PTRobot_SetRobotOptions(HANDLE hRobot, DWORD dwRobotOptions);

2.1.10 PTRobot_GetRobotOptions

///////////////////////////

// PTRobot_GetRobotOptions

PTRobot API Page 13 of 41

their respective companies.

// Description:

// Function to get the current robot options.

// Params:

// hRobot Handle to the robot

// pdwRobotOptions points to a DWORD.

// See

"Robot Options" defines above

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

///////////////////////////

DWORD WINAPI PTRobot_GetRobotOptions(HANDLE hRobot, DWORD *pdwRobotOptions);

2.1.11 PTRobot_GetErrorString

///////////////////////////

// PTRobot_GetErrorString

// Description:

// Function to get the error string for a specific system

// error or PTRobot API Return error.

// Params:

// hRobot Handle to the robot (from EnumRobots)

// (Use NULL only if no handle has been obtained yet)

// dwErrorNum System Error Number

// pwszErrorString Error string returned

// (Note wide characters. Calling application must

// allocate this memory).

// dwMaxLength Length of buffer pointed to by pwszErrorString

// (number of wide characters)

// dwLanguage Language of string to return (See "Languages"

// definitions above)

// Notes:

// dwErrorNum can be either dwSystemError from PTRobotStatus structure (which is

// returned by PTRobot_GetRobotStatus()) or dwErrorNum can be an error returned

// from a PTRobot_xxxxx call (e.g. PTROBOT_INVALID_ROBOT).

// Return:

// PTROBOT_OK if Successful

// PTROBOT_INVALID_LANG if language is invalid

// PTROBOT_INVALID_ERROR if error is invalid

// PTROBOT_INTERNAL if buffer is undersized, etc.

///////////////////////////

DWORD WINAPI PTRobot_GetErrorString(HANDLE hRobot, DWORD dwErrorNum,

WCHAR *pwszErrorString, DWORD dwMaxLength,

DWORD dwLanguage);

PTRobot API Page 14 of 41

their respective companies.

2.1.12 PTRobot_SetApplicationID

///////////////////////////

// PTRobot_SetApplicationID

// Description:

// Function to set the Application ID.

// The ID value is assigned for each application by Primera as needed.

// Only applications that require special functionality will require this.

// (note most applications will not need this).

// Params:

// dwAppID Application ID specified by Primera

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_INTERNAL if an internal error occurred

///////////////////////////

DWORD WINAPI PTRobot_SetApplicationID( DWORD dwAppID );

2.2 PTRobot Info/Status Functions

2.2.1 PTRobot_GetDriveInfo

///////////////////////////

// PTRobot_GetDriveInfo

// Description:

// Function to get the drive info for a particular

// drive handle.

// Params:

// hDrive Handle to the drive (from EnumDrives)

// pDrvInfo points to a PTDriveInfo structure.

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_DRIVE if the drive handle is invalid

///////////////////////////

DWORD WINAPI PTRobot_GetDriveInfo(HANDLE hDrive, PTDriveInfo*pDrvInfo);

2.2.2 PTRobot_GetRobotInfo

///////////////////////////

// PTRobot_GetRobotInfo

PTRobot API Page 15 of 41

their respective companies.

// Description:

// Function to get the robot info for a particular

// robot handle.

// Params:

// hRobot Handle to the robot (from EnumRobots)

// pRobotInfo points to a PTRobotInfo structure.

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

///////////////////////////

DWORD WINAPI PTRobot_GetRobotInfo(HANDLE hRobot, PTRobotInfo *pRobotInfo);

2.2.3 PTRobot_GetRobotStatus

///////////////////////////

// PTRobot_GetRobotStatus

// Description:

// Function to get the current status for a particular

// robot.

// Params:

// hRobot Handle to the robot (from EnumRobots)

// pRobotStatus points to a PTRobotStatus structure.

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

///////////////////////////

DWORD WINAPI PTRobot_GetRobotStatus(HANDLE hRobot, PTRobotStatus *pRobotStatus);

2.2.4 PTRobot_GetMediaInfo

///////////////////////////

// PTRobot_GetMediaInfo

// Description:

// This function will get information on the media that

// is loaded in the drive.

// Params:

// hDrive Handle to the drive (from EnumDrives)

// PTMediaInfo * points to Media info structure (see section 3.5)

// (the structure will be filled in if successful)

// Notes:

// Return:

// PTROBOT_OK if successful and media is found and the media is valid.

PTRobot API Page 16 of 41

their respective companies.

// PTROBOT_INVALID_MEDIA if the media is not valid

// PTROBOT_NO_MEDIA if no media is found

// PTROBOT_INVALID_DRIVE if the drive is not valid

// PTROBOT_INTERNAL some other error

///////////////////////////

DWORD WINAPI PTRobot_GetMediaInfo(HANDLE hDrive, PTMediaInfo *pDiscInfo );

2.2.5 PTRobot_GetRobotInfo2

///////////////////////////

// PTRobot_GetRobotInfo2

// Description:

// Function to get ADDITIONAL robot info for a particular

// robot handle.

// Params:

// hRobot Handle to the robot (from EnumRobots)

// pRobotInfo2 points to a PTRobotInfo structure.

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

///////////////////////////

DWORD WINAPI PTRobot_GetRobotInfo2(HANDLE hRobot, PTRobotInfo2 *pRobotInfo2);

2.2.6 PTRobot_GetRobotStatus2

///////////////////////////

// PTRobot_GetRobotStatus2

// Description:

// Function to get the Additional current status for a particular

// robot.

// Params:

// hRobot Handle to the robot (from EnumRobots)

// pRobotStatus2 points to a PTRobotStatus2 structure.

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_BUSY if no response from robot

///////////////////////////

DWORD WINAPI PTRobot_GetRobotStatus2(HANDLE hRobot, PTRobotStatus2 *pRobotStatus2);

PTRobot API Page 17 of 41

their respective companies.

2.3 PTRobot Robotic Functions

2.3.1 PTRobot_LoadDrive

///////////////////////////

// PTRobot_LoadDrive

// Description:

// Function to load a drive from an input location

// Params:

// hRobot Handle to the robot (from EnumRobots)

// hDrive Handle to the drive (from EnumDrives)

// dwFromLocation DWORD containing the "from" location

// LOCATION_AUTO = Automatically choose the bin

// 1 = Bin1 (right-most bin)

// 2 = Bin2

// ...

// LOCATION_PRINTER = Printer

// dwClearDrive Clear drive before loading.

// (See Clear Drive section)

// Notes:

// Clear drive before loading should be done the first loading. This will

// cause the picker to attempt to pick discs out of the drive to determine

// if any discs were left in the drive from a previous job.

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_INVALID_DRIVE if the drive handle is invalid

// PTROBOT_INVALID_LOCATION if the location is invalid

///////////////////////////

DWORD WINAPI PTRobot_LoadDrive(HANDLE hRobot, HANDLE hDrive, DWORD dwFromLocation, DWORD

dwClearDrive);

2.3.2 PTRobot_LoadPrinter

///////////////////////////

// PTRobot_LoadPrinter

// Description:

// Function to load the printer from an input bin location

// Params:

// hRobot Handle to the robot (from EnumRobots)

// dwFromLocation DWORD containing the "from" location

PTRobot API Page 18 of 41

their respective companies.

// LOCATION_AUTO = Automatically choose the bin

// 1 = Bin1 (right-most bin)

// 2 = Bin2

// ...

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_NO_PRINTER if the robot doesn't have a printer

// PTROBOT_INVALID_LOCATION if the location is invalid

///////////////////////////

DWORD WINAPI PTRobot_LoadPrinter(HANDLE hRobot, DWORD dwFromLocation);

2.3.3 PTRobot_LoadPrinterFromDrive

///////////////////////////

// PTRobot_LoadPrinterFromDrive

// Description:

// Function to load the printer from a drive

// Params:

// hRobot Handle to the robot (from EnumRobots)

// hDrive Handle to the drive (from EnumDrives)

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_INVALID_DRIVE if the drive handle is invalid

// PTROBOT_NO_PRINTER if the robot doesn't have a printer

///////////////////////////

DWORD WINAPI PTRobot_LoadPrinterFromDrive(HANDLE hRobot, HANDLE hDrive);

2.3.4 PTRobot_UnLoadDrive

///////////////////////////

// PTRobot_UnLoadDrive

// Description:

// Function to unload the drive to an output position.

// Params:

// hRobot Handle to the robot (from EnumRobots)

// hDrive Handle to the drive (from EnumDrives)

// dwToLocation DWORD containing the "to" location

PTRobot API Page 19 of 41

their respective companies.

// LOCATION_AUTO = Automatically choose the bin

// 1 = Bin1 (right-most bin)

// 2 = Bin2

// ...

// LOCATION_REJECT = Reject

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_INVALID_DRIVE if the drive handle is invalid

// PTROBOT_INVALID_LOCATION if the location is invalid

///////////////////////////

DWORD WINAPI PTRobot_UnLoadDrive(HANDLE hRobot, HANDLE hDrive, DWORD dwToLocation);

2.3.5 PTRobot_UnLoadPrinter

///////////////////////////

// PTRobot_UnLoadPrinter

// Description:

// Function to unload the printer to an output position.

// Params:

// hRobot Handle to the robot (from EnumRobots)

// dwToLocation DWORD containing the "to" location

// LOCATION_AUTO = Automatically choose the bin

// 1 = Bin1 (right-most bin)

// 2 = Bin2

// ...

// LOCATION_REJECT = Reject

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_NO_PRINTER if the robot doesn't have a printer

// PTROBOT_INVALID_LOCATION if the location is invalid

///////////////////////////

DWORD WINAPI PTRobot_UnLoadPrinter(HANDLE hRobot, DWORD dwToLocation);

2.3.6 PTRobot_MoveDiscBetweenLocations

///////////////////////////

// PTRobot_MoveDiscBetweenLocations

PTRobot API Page 20 of 41

their respective companies.

// Description:

// Function to move disc from one bin to another bin

// Params:

// hRobot Handle to the robot (from EnumRobots)

// dwFromLocation DWORD containing the from location

// 1 = Bin1 (right-most bin)

// 2 = Bin2

// ...

// dwToLocation DWORD containing the "to" location

// 1 = Bin1 (right-most bin)

// 2 = Bin2

// ...

// LOCATION_REJECT = Reject

// Notes:

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_INVALID_LOCATION if the location is invalid

///////////////////////////

DWORD WINAPI PTRobot_MoveDiscBetweenLocations(HANDLE hRobot, DWORD dwFromLocation, DWORD

dwToLocation)

2.3.7 PTRobot_PrintFile

///////////////////////////

// PTRobot_PrintFile

// Description:

// Function to print a Surething image (.STD), raster image (.JPG, .BMP, .TIF,

// etc.), or .PRN file to the printer.

// Params:

// hRobot Handle to the robot (from EnumRobots)

// tszFile File to print (.STD, .PRN, .JPG, .BMP)

// dwPrintIndex Print index for multiple print jobs.

// Notes:

// The dwPrintIndex is used when printing an .STD file with merge fields. This

// value represents which merge record to use for this print.

// Return:

// PTROBOT_OK if Successful

// PTROBOT_SEQUENCE if this command is called out of sequence

// PTROBOT_INTERNAL if an internal error occurred

// PTROBOT_INVALID_ROBOT if the robot handle is invalid

// PTROBOT_NO_PRINTER if the robot doesn't have a printer

// PTROBOT_PRN_INVALID if the prn file is not valid for the printer

// PTROBOT_PRINTFILE_NOT_FOUND if the file doesn't exist

// PTROBOT_PRINTAPP_NOT_INSTALLED if the required print application is not

// installed.

///////////////////////////

Table of contents

Other Primera Software manuals

Primera

Primera PrimoDVD User manual

Primera

Primera 510869 User manual

Primera

Primera PoINT Publisher User manual

Primera

Primera PTBurn 3 SDK User manual

Primera

Primera SureThing User manual

Primera

Primera PTBurn SDK User manual

Primera

Primera Discribe5 User manual

Primera

Primera PTPublisher NE User manual

Primera

Primera PrimaBar User manual

Popular Software manuals by other brands

DH Instruments

DH Instruments MOLBOX ANALOG CIRCUIT user manual

Avermedia

Avermedia Driver and TV tuner user manual

Samsung

Samsung UN40C7000WF user manual

Motorola

Motorola 98653H - Mobile PhoneTools Plus USB Cable user guide

deXlan

deXlan TVExpert 874-00101 user manual

ESET

ESET NOD32 ANTIVIRUS 4 - FOR MICROSOFT WINDOWS... user guide

Canon

Canon EOS-1D Mark II Digial Software guide

Sharp

Sharp PixLab Online manual

Dell

Dell PowerEdge 180AS user guide

TC Electronic

TC Electronic Tube-Tech CL 1B product manual

Kyocera

Kyocera KM-1820 user guide

Nortel

Nortel 251 Using

Lenovo

Lenovo ThinkCentre A62 Deployment guide

Aruba Networks

Aruba Networks PowerConnect W Clearpass 100 Software Deployment guide

Altigen

Altigen Advanced Call Router manual

GRASS VALLEY

GRASS VALLEY K2 FCP CONNECT 2.0 - S installation manual

Autodesk

Autodesk 24108-051400-9000 - AutoCAD Revit Architecture Suite... Getting started guide

VMware

VMware VS4-ENT-PL-A - vSphere Enterprise Plus Setup guide

Primera PTRobot API User manual

Popular Software manuals by other brands