Primera PTRobot API, User Manual

Page: 15 / 41

PTRobot API Page 15 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.
// 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.