All Frameworks Class Hierarchy This Framework Next Indexes
DNBRobotInterfaces Interface DNBIRobRRSSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---DNBIRobRRSSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DNBIRobRRSSettingAtt
Interface to handle parameters of IGRIP RRS Tools Options Tab page
Role: This interface is implemented by a component which
represents the controller of IGRIP RRS Tools Options parameter settings.
- Methods to set value of each parameter
- Methods to get value of each parameter
- Methods to get information on each parameter
- Methods to lock/unlock value of each parameter
Method Index
- o
AddNewRRS2ControllerIdentifier(CATUnicodeString&)
- Adds new controller identifier into the list represented by the
"RRS2ControllerIdentifiers" parameter.
- o
GetRCSDataLibDir(CATUnicodeString&)
- Gets value of "RCSDATA$LIB" parameter.
- o
GetRCSDataLibDirInfo(CATSettingInfo*)
- Gets information on "RCSDATA$LIB" parameter.
- o
GetRRS2ConnectDownloaders(CATUnicodeString&)
- Gets value of "RRS2ConnectDownloaders" parameter.
- o
GetRRS2ConnectDownloadersInfo(CATSettingInfo*)
- Gets information on "RRS2ConnectDownloaders" parameter.
- o
GetRRS2ConsistencyCmdDownloaders(CATUnicodeString&)
- Gets value of "RRS2ConsistencyCmdDownloaders" parameter.
- o
GetRRS2ConsistencyCmdDownloadersInfo(CATSettingInfo*)
- Gets information on "RRS2ConsistencyCmdDownloaders" parameter.
- o
GetRRS2ControllerIdentifierAttributes(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATBoolean&,CATBoolean&,CATBoolean&,CATBoolean&)
- Gets various controller identifier-specific attributes associated
with a given controller identifier.
- o
GetRRS2ControllerIdentifiers(CATUnicodeString&)
- Gets value of "RRS2ControllerIdentifiers" parameter.
- o
GetRRS2ControllerIdentifiersInfo(CATSettingInfo*)
- Gets information on "RRS2ControllerIdentifiers" parameter.
- o
GetRRS2DeleteAutoDownloadFilesAfterXfer(CATBoolean&)
- Gets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- o
GetRRS2DeleteAutoDownloadFilesAfterXferInfo(CATSettingInfo*)
- Gets information on "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- o
GetRRS2DfltControllerIdentifier(CATUnicodeString&)
- Gets value of "RRS2DfltControllerIdentifier" parameter.
- o
GetRRS2DfltControllerIdentifierInfo(CATSettingInfo*)
- Gets information on "RRS2DfltControllerIdentifier" parameter.
- o
GetRRS2DownloadDuringConnect(CATUnicodeString&)
- Gets value of "RRS2DownloadDuringConnect" parameter.
- o
GetRRS2DownloadDuringConnectInfo(CATSettingInfo*)
- Gets information on "RRS2DownloadDuringConnect" parameter.
- o
GetRRS2DownloadDuringSimRun(CATUnicodeString&)
- Gets value of "RRS2DownloadDuringSimRun" parameter.
- o
GetRRS2DownloadDuringSimRunInfo(CATSettingInfo*)
- Gets information on "RRS2DownloadDuringSimRun" parameter.
- o
GetRRS2DownloadInPartCoordinates(CATUnicodeString&)
- Gets value of "RRS2DownloadInPartCoordinates" parameter.
- o
GetRRS2DownloadInPartCoordinatesInfo(CATSettingInfo*)
- Gets information on "RRS2DownloadInPartCoordinates" parameter.
- o
GetRRS2DownloadLogFileName(CATUnicodeString&)
- Gets value of "RRS2DownloadLogFileName" parameter.
- o
GetRRS2DownloadLogFileNameInfo(CATSettingInfo*)
- Gets information on "RRS2DownloadLogFileName" parameter.
- o
GetRRS2FreePlaySimStepSize(float&)
- Gets value of "RRS2FreePlaySimStepSize" parameter.
- o
GetRRS2FreePlaySimStepSizeInfo(CATSettingInfo*)
- Gets information on "RRS2FreePlaySimStepSize" parameter.
- o
GetRRS2MainTaskProcessing(CATBoolean&)
- Gets value of "RRS2MainTaskProcessing" parameter.
- o
GetRRS2MainTaskProcessingInfo(CATSettingInfo*)
- Gets information on "RRS2MainTaskProcessing" parameter.
- o
GetRRS2MotionPlannerActiveDuringTeachOLP(CATBoolean&)
- Gets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- o
GetRRS2MotionPlannerActiveDuringTeachOLPInfo(CATSettingInfo*)
- Gets information on "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- o
GetRRS2SimRunDownloaders(CATUnicodeString&)
- Gets value of "RRS2SimRunDownloaders" parameter.
- o
GetRRS2SimRunDownloadersInfo(CATSettingInfo*)
- Gets information on "RRS2SimRunDownloaders" parameter.
- o
GetRRS2StopVRCWhenSimStops(CATBoolean&)
- Gets value of "RRS2StopVRCWhenSimStops" parameter.
- o
GetRRS2StopVRCWhenSimStopsInfo(CATSettingInfo*)
- Gets information on "RRS2StopVRCWhenSimStops" parameter.
- o
GetRRS2UpdateProgramOnDownload(CATUnicodeString&)
- Gets value of "RRS2UpdateProgramOnDownloads" parameter.
- o
GetRRS2UpdateProgramOnDownloadInfo(CATSettingInfo*)
- Gets information on "RRS2UpdateProgramOnDownloads" parameter.
- o
GetRRS2UseVRCInverseKinematics(CATBoolean&)
- Gets value of "RRS2UseVRCInverseKinematics" parameter.
- o
GetRRS2UseVRCInverseKinematicsInfo(CATSettingInfo*)
- Gets information on "RRS2UseVRCInverseKinematics" parameter.
- o
GetRRS2UseVRCTurnLimits(CATBoolean&)
- Gets value of "RRS2UseVRCTurnLimits" parameter.
- o
GetRRS2UseVRCTurnLimitsInfo(CATSettingInfo*)
- Gets information on "RRS2UseVRCTurnLimits" parameter.
- o
GetRRSLibDir(CATUnicodeString&)
- Gets value of "RRS$LIB" parameter.
- o
GetRRSLibDirInfo(CATSettingInfo*)
- Gets information on "RRS$LIB" parameter.
- o
GetRRSServerFile(CATUnicodeString&)
- Gets value of "RRS Servers File" parameter.
- o
GetRRSServerFileInfo(CATSettingInfo*)
- Gets information on "RRS Servers File" parameter.
- o
SetRCSDataLibDir(CATUnicodeString&)
- Sets value of "RCSDATA$LIB" parameter.
- o
SetRCSDataLibDirLock(unsigned char)
- Locks or unlocks the "RCSDATA$LIB" parameter.
- o
SetRRS2ConnectDownloaders(CATUnicodeString&)
- Sets value of "RRS2ConnectDownloaders" parameter.
- o
SetRRS2ConnectDownloadersLock(unsigned char)
- Locks or unlocks the "RRS2ConnectDownloaders" parameter.
- o
SetRRS2ConsistencyCmdDownloaders(CATUnicodeString&)
- Sets value of "RRS2ConsistencyCmdDownloaders" parameter.
- o
SetRRS2ConsistencyCmdDownloadersLock(unsigned char)
- Locks or unlocks the "RRS2ConsistencyCmdDownloaders" parameter.
- o
SetRRS2ControllerIdentifiers(CATUnicodeString&)
- Sets value of "RRS2ControllerIdentifiers" parameter.
- o
SetRRS2ControllerIdentifiersLock(unsigned char)
- Locks or unlocks the "RRS2ControllerIdentifiers" parameter.
- o
SetRRS2DeleteAutoDownloadFilesAfterXfer(CATBoolean)
- Sets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- o
SetRRS2DeleteAutoDownloadFilesAfterXferLock(unsigned char)
- Locks or unlocks the "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- o
SetRRS2DfltControllerIdentifier(CATUnicodeString&)
- Sets value of "RRS2DfltControllerIdentifier" parameter.
- o
SetRRS2DfltControllerIdentifierLock(unsigned char)
- Locks or unlocks the "RRS2DfltControllerIdentifier" parameter.
- o
SetRRS2DownloadDuringConnect(CATUnicodeString&)
- Sets value of "RRS2DownloadDuringConnect" parameter.
- o
SetRRS2DownloadDuringConnectLock(unsigned char)
- Locks or unlocks the "RRS2DownloadDuringConnect" parameter.
- o
SetRRS2DownloadDuringSimRun(CATUnicodeString&)
- Sets value of "RRS2DownloadDuringSimRun" parameter.
- o
SetRRS2DownloadDuringSimRunLock(unsigned char)
- Locks or unlocks the "RRS2DownloadDuringSimRun" parameter.
- o
SetRRS2DownloadInPartCoordinates(CATUnicodeString&)
- Sets value of "RRS2DownloadInPartCoordinates" parameter.
- o
SetRRS2DownloadInPartCoordinatesLock(unsigned char)
- Locks or unlocks the "RRS2DownloadInPartCoordinates" parameter.
- o
SetRRS2DownloadLogFileName(CATUnicodeString&)
- Sets value of "RRS2DownloadLogFileName" parameter.
- o
SetRRS2DownloadLogFileNameLock(unsigned char)
- Locks or unlocks the "RRS2DownloadLogFileName" parameter.
- o
SetRRS2FreePlaySimStepSize(float)
- Sets value of "RRS2FreePlaySimStepSize" parameter.
- o
SetRRS2FreePlaySimStepSizeLock(unsigned char)
- Locks or unlocks the "RRS2FreePlaySimStepSize" parameter.
- o
SetRRS2MainTaskProcessing(CATBoolean)
- Sets value of "RRS2MainTaskProcessing" parameter.
- o
SetRRS2MainTaskProcessingLock(unsigned char)
- Locks or unlocks the "RRS2MainTaskProcessing" parameter.
- o
SetRRS2MotionPlannerActiveDuringTeachOLP(CATBoolean)
- Sets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- o
SetRRS2MotionPlannerActiveDuringTeachOLPLock(unsigned char)
- Locks or unlocks the "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- o
SetRRS2SimRunDownloaders(CATUnicodeString&)
- Sets value of "RRS2SimRunDownloaders" parameter.
- o
SetRRS2SimRunDownloadersLock(unsigned char)
- Locks or unlocks the "RRS2SimRunDownloaders" parameter.
- o
SetRRS2StopVRCWhenSimStops(CATBoolean)
- Sets value of "RRS2StopVRCWhenSimStops" parameter.
- o
SetRRS2StopVRCWhenSimStopsLock(unsigned char)
- Locks or unlocks the "RRS2StopVRCWhenSimStops" parameter.
- o
SetRRS2UpdateProgramOnDownload(CATUnicodeString&)
- Sets value of "RRS2UpdateProgramOnDownloads" parameter.
- o
SetRRS2UpdateProgramOnDownloadLock(unsigned char)
- Locks or unlocks the "RRS2UpdateProgramOnDownloads" parameter.
- o
SetRRS2UseVRCInverseKinematics(CATBoolean)
- Sets value of "RRS2UseVRCInverseKinematics" parameter.
- o
SetRRS2UseVRCInverseKinematicsLock(unsigned char)
- Locks or unlocks the "RRS2UseVRCInverseKinematics" parameter.
- o
SetRRS2UseVRCTurnLimits(CATBoolean)
- Sets value of "RRS2UseVRCTurnLimits" parameter.
- o
SetRRS2UseVRCTurnLimitsLock(unsigned char)
- Locks or unlocks the "RRS2UseVRCTurnLimits" parameter.
- o
SetRRSLibDir(CATUnicodeString&)
- Sets value of "RRS$LIB" parameter.
- o
SetRRSLibDirLock(unsigned char)
- Locks or unlocks the "RRS$LIB" parameter.
- o
SetRRSServerFile(CATUnicodeString&)
- Sets value of "RRS Servers File" parameter.
- o
SetRRSServerFileLock(unsigned char)
- Locks or unlocks the "RRS Servers File" parameter.
Methods
o AddNewRRS2ControllerIdentifier
-
Adds new controller identifier into the list represented by the
"RRS2ControllerIdentifiers" parameter. If it is already in the
list, does nothing.
Role: Adds new controller identifier to
"RRS2ControllerIdentifiers" list.
- Parameters:
-
- iControllerIdentifier
- Controller Identifier to be added to the list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRCSDataLibDir
-
Gets value of "RCSDATA$LIB" parameter.
Role: Gets value of "RCSDATA$LIB" parameter
- Parameters:
-
- oDataDir
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRCSDataLibDirInfo
-
Gets information on "RCSDATA$LIB" parameter.
Role: Gets information on "RCSDATA$LIB" parameter
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ConnectDownloaders
-
Gets value of "RRS2ConnectDownloaders" parameter.
Role: Gets value of "RRS2ConnectDownloaders" parameter.
Each element corresponds to the controller at the
same position in the "RRS2ControllersIdentifiers" list.
- Parameters:
-
- oRRS2ConnectDownloaders
- Variable to return value in. Formatted as an array of
elements separated by ";" where each element corresponds
to the controller at the same position in the
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ConnectDownloadersInfo
-
Gets information on "RRS2ConnectDownloaders" parameter.
Role: Gets information on "RRS2ConnectDownloaders" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ConsistencyCmdDownloaders
-
Gets value of "RRS2ConsistencyCmdDownloaders" parameter.
Role: Gets value of "RRS2ConsistencyCmdDownloaders" parameter.
- Parameters:
-
- oRRS2ConsistencyCmdDownloaders
- Variable to return value in. Formatted as an array of
elements separated by ";" where each element corresponds
to the controller at the same position in the
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ConsistencyCmdDownloadersInfo
-
Gets information on "RRS2ConsistencyCmdDownloaders" parameter.
Role: Gets information on "RRS2ConsistencyCmdDownloaders" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ControllerIdentifierAttributes
-
Gets various controller identifier-specific attributes associated
with a given controller identifier.
Role: Gets various attributes associated with
a given controller identifier.
- Parameters:
-
- iControllerIdentifier
- Controller Identifier whose attributes are requested.
- iControllerIdentifier
- Controller Identifier whose attributes are requested.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ControllerIdentifiers
-
Gets value of "RRS2ControllerIdentifiers" parameter.
Role: Gets value of "RRS2ControllerIdentifiers" parameter.
- Parameters:
-
- oRRS2ControllerIdentifiers
- Variable to return value in. Formatted as an array of
elements separated by ";".
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ControllerIdentifiersInfo
-
Gets information on "RRS2ControllerIdentifiers" parameter.
Role: Gets information on "RRS2ControllerIdentifiers" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DeleteAutoDownloadFilesAfterXfer
public virtual HRESULT GetRRS2DeleteAutoDownloadFilesAfterXfer( | CATBoolean& | oRRS2DeleteAutoDownloadFilesAfterXfer)= 0 |
-
Gets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
Role: Gets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- Parameters:
-
- oRRS2DeleteAutoDownloadFilesAfterXfer
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DeleteAutoDownloadFilesAfterXferInfo
-
Gets information on "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
Role: Gets information on "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DfltControllerIdentifier
-
Gets value of "RRS2DfltControllerIdentifier" parameter.
Role: Gets value of "RRS2DfltControllerIdentifier" parameter.
- Parameters:
-
- oRRS2DfltControllerIdentifier
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DfltControllerIdentifierInfo
-
Gets information on "RRS2DfltControllerIdentifier" parameter.
Role: Gets information on "RRS2DfltControllerIdentifier" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadDuringConnect
-
Gets value of "RRS2DownloadDuringConnect" parameter.
Role: Gets value of "RRS2DownloadDuringConnect" parameter.
- Parameters:
-
- oRRS2DownloadDuringConnect
- Variable to return value in. Formatted as an array of
elements separated by ";"
where each element has a value 1 for TRUE and 0 for FALSE, and
corresponds to the controller at the same position in the
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadDuringConnectInfo
-
Gets information on "RRS2DownloadDuringConnect" parameter.
Role: Gets information on "RRS2DownloadDuringConnect" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadDuringSimRun
-
Gets value of "RRS2DownloadDuringSimRun" parameter.
Role: Gets value of "RRS2DownloadDuringSimRun" parameter.
- Parameters:
-
- oRRS2DownloadDuringSimRun
- Variable to return value in. Formatted as an array of
elements separated by ";" where each element has a value 1
for TRUE and 0 for FALSE, and corresponds to the controller
at the same position in the "RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadDuringSimRunInfo
-
Gets information on "RRS2DownloadDuringSimRun" parameter.
Role: Gets information on "RRS2DownloadDuringSimRun" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadInPartCoordinates
-
Gets value of "RRS2DownloadInPartCoordinates" parameter.
Role: Gets value of "RRS2DownloadInPartCoordinates" parameter.
- Parameters:
-
- oRRS2DownloadInPartCoordinates
- Variable to return value in. Formatted as an array of
elements separated by ";" where each element has a
value 1 for TRUE and 0 for FALSE, and corresponds to the
controller at the same position in the
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadInPartCoordinatesInfo
-
Gets information on "RRS2DownloadInPartCoordinates" parameter.
Role: Gets information on "RRS2DownloadInPartCoordinates" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadLogFileName
-
Gets value of "RRS2DownloadLogFileName" parameter.
Role: Gets value of "RRS2DownloadLogFileName" parameter.
- Parameters:
-
- oRRS2DownloadLogFileName
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadLogFileNameInfo
-
Gets information on "RRS2DownloadLogFileName" parameter.
Role: Gets information on "RRS2DownloadLogFileName" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2FreePlaySimStepSize
public virtual HRESULT GetRRS2FreePlaySimStepSize( | float& | oRRS2FreePlaySimStepSize)= 0 |
-
Gets value of "RRS2FreePlaySimStepSize" parameter.
Role: Gets value of "RRS2FreePlaySimStepSize" parameter.
- Parameters:
-
- oRRS2FreePlaySimStepSize
- Variable to return value in seconds.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2FreePlaySimStepSizeInfo
-
Gets information on "RRS2FreePlaySimStepSize" parameter.
Role: Gets information on "RRS2FreePlaySimStepSize" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2MainTaskProcessing
-
Gets value of "RRS2MainTaskProcessing" parameter.
Role: Gets value of "RRS2MainTaskProcessing" parameter.
- Parameters:
-
- oRRS2MainTaskProcessing
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2MainTaskProcessingInfo
-
Gets information on "RRS2MainTaskProcessing" parameter.
Role: Gets information on "RRS2MainTaskProcessing" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2MotionPlannerActiveDuringTeachOLP
public virtual HRESULT GetRRS2MotionPlannerActiveDuringTeachOLP( | CATBoolean& | oRRS2MotionPlannerActiveDuringTeachOLP) = 0 |
-
Gets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
Role: Gets value of "RRS2MotionPlannerActiveDuringTeachOLP"
parameter.
- Parameters:
-
- oRRS2MotionPlannerActiveDuringTeachOLP
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2MotionPlannerActiveDuringTeachOLPInfo
-
Gets information on "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
Role: Gets information on
"RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2SimRunDownloaders
-
Gets value of "RRS2SimRunDownloaders" parameter.
Role: Gets value of "RRS2SimRunDownloaders" parameter.
- Parameters:
-
- oRRS2SimRunDownloaders
- Variable to return value in. Formatted as an array of
elements separated by ";" where each element corresponds
to the controller at the same position in the
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2SimRunDownloadersInfo
-
Gets information on "RRS2SimRunDownloaders" parameter.
Role: Gets information on "RRS2SimRunDownloaders" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2StopVRCWhenSimStops
public virtual HRESULT GetRRS2StopVRCWhenSimStops( | CATBoolean& | oRRS2StopVRCWhenSimStops)= 0 |
-
Gets value of "RRS2StopVRCWhenSimStops" parameter.
Role: Gets value of "RRS2StopVRCWhenSimStops" parameter.
- Parameters:
-
- oRRS2StopVRCWhenSimStops
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2StopVRCWhenSimStopsInfo
-
Gets information on "RRS2StopVRCWhenSimStops" parameter.
Role: Gets information on "RRS2StopVRCWhenSimStops" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2UpdateProgramOnDownload
-
Gets value of "RRS2UpdateProgramOnDownloads" parameter.
Role: Gets value of "RRS2UpdateProgramOnDownloads" parameter.
- Parameters:
-
- oRRS2UpdateProgramOnDownloads
- Variable to return value in. Formatted as an array of
elements separated by ";" where each element has a value 1
for TRUE and 0 for FALSE, and corresponds to the controller
at the same position in the "RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2UpdateProgramOnDownloadInfo
-
Gets information on "RRS2UpdateProgramOnDownloads" parameter.
Role: Gets information on "RRS2UpdateProgramOnDownloads" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2UseVRCInverseKinematics
public virtual HRESULT GetRRS2UseVRCInverseKinematics( | CATBoolean& | oRRS2UseVRCInverseKinematics)= 0 |
-
Gets value of "RRS2UseVRCInverseKinematics" parameter.
Role: Gets value of "RRS2UseVRCInverseKinematics" parameter.
- Parameters:
-
- oRRS2UseVRCInverseKinematics
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2UseVRCInverseKinematicsInfo
-
Gets information on "RRS2UseVRCInverseKinematics" parameter.
Role: Gets information on "RRS2UseVRCInverseKinematics" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2UseVRCTurnLimits
-
Gets value of "RRS2UseVRCTurnLimits" parameter.
Role: Gets value of "RRS2UseVRCTurnLimits" parameter.
- Parameters:
-
- oRRS2UseVRCTurnLimits
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2UseVRCTurnLimitsInfo
-
Gets information on "RRS2UseVRCTurnLimits" parameter.
Role: Gets information on "RRS2UseVRCTurnLimits" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRSLibDir
-
Gets value of "RRS$LIB" parameter.
Role: Gets value of "RRS$LIB" parameter
- Parameters:
-
- oLibDir
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRSLibDirInfo
-
Gets information on "RRS$LIB" parameter.
Role: Gets information on "RRS$LIB" parameter
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRSServerFile
-
Gets value of "RRS Servers File" parameter.
Role: Gets value of "RRS Servers File" parameter
- Parameters:
-
- oServerFile
- Variable to return value in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRSServerFileInfo
-
Gets information on "RRS Servers File" parameter.
Role: Gets information on "RRS Servers File" parameter
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRCSDataLibDir
-
Sets value of "RCSDATA$LIB" parameter.
Role: Sets value of "RCSDATA$LIB" parameter
- Parameters:
-
- iDataDir
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRCSDataLibDirLock
public virtual HRESULT SetRCSDataLibDirLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "RCSDATA$LIB" parameter.
Role: Locks or unlocks the "RCSDATA$LIB" parameter if the
operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2ConnectDownloaders
-
Sets value of "RRS2ConnectDownloaders" parameter.
Role: Sets value of "RRS2ConnectDownloaders" parameter.
Each element corresponds to the controller at the
same position in the "RRS2ControllersIdentifiers" list.
- Parameters:
-
- iRRS2ConnectDownloaders
- New value. Formatted as an array of elements separated by ";"
where each element corresponds to the controller at the
same position in the "RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2ConnectDownloadersLock
public virtual HRESULT SetRRS2ConnectDownloadersLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2ConnectDownloaders" parameter.
Role: Locks or unlocks the "RRS2ConnectDownloaders"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2ConsistencyCmdDownloaders
-
Sets value of "RRS2ConsistencyCmdDownloaders" parameter.
Role: Sets value of "RRS2ConsistencyCmdDownloaders" parameter.
- Parameters:
-
- iRRS2ConsistencyCmdDownloaders
- New value. Formatted as an array of elements separated by ";"
where each element corresponds to the controller at the
same position in the "RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2ConsistencyCmdDownloadersLock
public virtual HRESULT SetRRS2ConsistencyCmdDownloadersLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2ConsistencyCmdDownloaders" parameter.
Role: Locks or unlocks the "RRS2ConsistencyCmdDownloaders"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2ControllerIdentifiers
-
Sets value of "RRS2ControllerIdentifiers" parameter.
Role: Sets value of "RRS2ControllerIdentifiers" parameter.
- Parameters:
-
- iRRS2ControllerIdentifiers
- New value. Formatted as an array of
elements separated by ";".
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2ControllerIdentifiersLock
public virtual HRESULT SetRRS2ControllerIdentifiersLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2ControllerIdentifiers" parameter.
Role: Locks or unlocks the "RRS2ControllerIdentifiers"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DeleteAutoDownloadFilesAfterXfer
public virtual HRESULT SetRRS2DeleteAutoDownloadFilesAfterXfer( | CATBoolean | iRRS2DeleteAutoDownloadFilesAfterXfer)= 0 |
-
Sets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
Role: Sets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- Parameters:
-
- iRRS2DeleteAutoDownloadFilesAfterXfer
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DeleteAutoDownloadFilesAfterXferLock
public virtual HRESULT SetRRS2DeleteAutoDownloadFilesAfterXferLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
Role: Locks or unlocks the "RRS2DeleteAutoDownloadFilesAfterXfer" parameter
if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DfltControllerIdentifier
-
Sets value of "RRS2DfltControllerIdentifier" parameter.
Role: Sets value of "RRS2DfltControllerIdentifier" parameter.
- Parameters:
-
- iRRS2DfltControllerIdentifier
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DfltControllerIdentifierLock
public virtual HRESULT SetRRS2DfltControllerIdentifierLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2DfltControllerIdentifier" parameter.
Role: Locks or unlocks the "RRS2DfltControllerIdentifier"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DownloadDuringConnect
-
Sets value of "RRS2DownloadDuringConnect" parameter.
Role: Sets value of "RRS2DownloadDuringConnect" parameter.
- Parameters:
-
- iRRS2DownloadDuringConnect
- New value. Formatted as an array of elements separated by ";"
where each element has a value 1 for TRUE and 0 for FALSE, and
corresponds to the controller at the same position in the
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DownloadDuringConnectLock
public virtual HRESULT SetRRS2DownloadDuringConnectLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2DownloadDuringConnect" parameter.
Role: Locks or unlocks the "RRS2DownloadDuringConnect"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DownloadDuringSimRun
-
Sets value of "RRS2DownloadDuringSimRun" parameter.
Role: Sets value of "RRS2DownloadDuringSimRun" parameter.
- Parameters:
-
- iRRS2DownloadDuringSimRun
- New value. Formatted as an array of elements separated by ";"
where each element has a value 1 for TRUE and 0 for FALSE, and
corresponds to the controller at the same position in the
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DownloadDuringSimRunLock
public virtual HRESULT SetRRS2DownloadDuringSimRunLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2DownloadDuringSimRun" parameter.
Role: Locks or unlocks the "RRS2DownloadDuringSimRun"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DownloadInPartCoordinates
-
Sets value of "RRS2DownloadInPartCoordinates" parameter.
Role: Sets value of "RRS2DownloadInPartCoordinates" parameter.
- Parameters:
-
- iRRS2DownloadInPartCoordinates
- New value. Formatted as an array of elements separated by ";"
where each element has a value 1 for TRUE and 0 for FALSE, and
corresponds to the controller at the same position in the
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DownloadInPartCoordinatesLock
public virtual HRESULT SetRRS2DownloadInPartCoordinatesLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2DownloadInPartCoordinates" parameter.
Role: Locks or unlocks the "RRS2DownloadInPartCoordinates"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DownloadLogFileName
-
Sets value of "RRS2DownloadLogFileName" parameter.
Role: Sets value of "RRS2DownloadLogFileName" parameter.
- Parameters:
-
- iRRS2DownloadLogFileName
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DownloadLogFileNameLock
public virtual HRESULT SetRRS2DownloadLogFileNameLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2DownloadLogFileName" parameter.
Role: Locks or unlocks the "RRS2DownloadLogFileName"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2FreePlaySimStepSize
public virtual HRESULT SetRRS2FreePlaySimStepSize( | float | iRRS2FreePlaySimStepSize)= 0 |
-
Sets value of "RRS2FreePlaySimStepSize" parameter.
Role: Sets value of "RRS2FreePlaySimStepSize" parameter.
- Parameters:
-
- iRRS2FreePlaySimStepSize
- New value in seconds.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2FreePlaySimStepSizeLock
public virtual HRESULT SetRRS2FreePlaySimStepSizeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "RRS2FreePlaySimStepSize" parameter.
Role: Locks or unlocks the "RRS2FreePlaySimStepSize" parameter
if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2MainTaskProcessing
public virtual HRESULT SetRRS2MainTaskProcessing( | CATBoolean | iRRS2MainTaskProcessing)= 0 |
-
Sets value of "RRS2MainTaskProcessing" parameter.
Role: Sets value of "RRS2MainTaskProcessing" parameter.
- Parameters:
-
- iRRS2MainTaskProcessing
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2MainTaskProcessingLock
public virtual HRESULT SetRRS2MainTaskProcessingLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "RRS2MainTaskProcessing" parameter.
Role: Locks or unlocks the "RRS2MainTaskProcessing" parameter
if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2MotionPlannerActiveDuringTeachOLP
public virtual HRESULT SetRRS2MotionPlannerActiveDuringTeachOLP( | CATBoolean | iRRS2MotionPlannerActiveDuringTeachOLP) = 0 |
-
Sets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
Role: Sets value of "RRS2MotionPlannerActiveDuringTeachOLP"
parameter.
- Parameters:
-
- iRRS2MotionPlannerActiveDuringTeachOLP
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2MotionPlannerActiveDuringTeachOLPLock
public virtual HRESULT SetRRS2MotionPlannerActiveDuringTeachOLPLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
Role: Locks or unlocks the
"RRS2MotionPlannerActiveDuringTeachOLP" parameter if the
operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2SimRunDownloaders
-
Sets value of "RRS2SimRunDownloaders" parameter.
Role: Sets value of "RRS2SimRunDownloaders" parameter.
- Parameters:
-
- iRRS2SimRunDownloaders
- New value. Formatted as an array of elements separated by ";"
where each element corresponds to the controller at the
same position in the "RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2SimRunDownloadersLock
public virtual HRESULT SetRRS2SimRunDownloadersLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2SimRunDownloaders" parameter.
Role: Locks or unlocks the "RRS2SimRunDownloaders"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2StopVRCWhenSimStops
public virtual HRESULT SetRRS2StopVRCWhenSimStops( | CATBoolean | iRRS2StopVRCWhenSimStops)= 0 |
-
Sets value of "RRS2StopVRCWhenSimStops" parameter.
Role: Sets value of "RRS2StopVRCWhenSimStops" parameter.
- Parameters:
-
- iRRS2StopVRCWhenSimStops
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2StopVRCWhenSimStopsLock
public virtual HRESULT SetRRS2StopVRCWhenSimStopsLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "RRS2StopVRCWhenSimStops" parameter.
Role: Locks or unlocks the "RRS2StopVRCWhenSimStops" parameter
if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2UpdateProgramOnDownload
-
Sets value of "RRS2UpdateProgramOnDownloads" parameter.
Role: Sets value of "RRS2UpdateProgramOnDownloads" parameter.
- Parameters:
-
- iRRS2UpdateProgramOnDownloads
- New value. Formatted as an array of elements separated by ";"
where each element has a value 1 for TRUE and 0 for FALSE, and
corresponds to the controller at the same position in the
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2UpdateProgramOnDownloadLock
public virtual HRESULT SetRRS2UpdateProgramOnDownloadLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "RRS2UpdateProgramOnDownloads" parameter.
Role: Locks or unlocks the "RRS2UpdateProgramOnDownloads"
parameter if the operation is allowed in the current administrated
environment. In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2UseVRCInverseKinematics
public virtual HRESULT SetRRS2UseVRCInverseKinematics( | CATBoolean | iRRS2UseVRCInverseKinematics)= 0 |
-
Sets value of "RRS2UseVRCInverseKinematics" parameter.
Role: Sets value of "RRS2UseVRCInverseKinematics" parameter.
- Parameters:
-
- iRRS2UseVRCInverseKinematics
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2UseVRCInverseKinematicsLock
public virtual HRESULT SetRRS2UseVRCInverseKinematicsLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "RRS2UseVRCInverseKinematics" parameter.
Role: Locks or unlocks the "RRS2UseVRCInverseKinematics" parameter
if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2UseVRCTurnLimits
-
Sets value of "RRS2UseVRCTurnLimits" parameter.
Role: Sets value of "RRS2UseVRCTurnLimits" parameter.
- Parameters:
-
- iRRS2MotionPlannerActiveDuringTeachOLP
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2UseVRCTurnLimitsLock
public virtual HRESULT SetRRS2UseVRCTurnLimitsLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "RRS2UseVRCTurnLimits" parameter.
Role: Locks or unlocks the "RRS2UseVRCTurnLimits" parameter
if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRSLibDir
-
Sets value of "RRS$LIB" parameter.
Role: Sets value of "RRS$LIB" parameter
- Parameters:
-
- iLibDir
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRSLibDirLock
public virtual HRESULT SetRRSLibDirLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "RRS$LIB" parameter.
Role: Locks or unlocks the "RRS$LIB" parameter if the
operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRSServerFile
-
Sets value of "RRS Servers File" parameter.
Role: Sets value of "RRS Servers File" parameter
- Parameters:
-
- iServerFile
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRSServerFileLock
public virtual HRESULT SetRRSServerFileLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "RRS Servers File" parameter.
Role: Locks or unlocks the "RRS Servers File" parameter if the
operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
This object is included in the file: DNBIRobRRSSettingAtt.h
If needed, your Imakefile.mk should include the module: DNBRobotItf