RRSSettingAtt (Object)

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.

Properties


Property RCSDataLibDir() As
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
Property RRS2ConnectDownloaders() As
Gets value of "RRS2ConnectDownloaders" parameter.
Role: Gets value of "RRS2ConnectDownloaders" parameter.
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
Property RRS2ConsistencyCmdDownloaders() As
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
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
Property RRS2ControllerIdentifiers() As
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
Property RRS2DeleteAutoDownloadFilesAfterXfer() As
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
Property RRS2DfltControllerIdentifier() As
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
Property RRS2DownloadDuringConnect() As
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
Property RRS2DownloadDuringSimRun() As
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
Property RRS2DownloadInPartCoordinates() As
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
Property RRS2DownloadLogFileName() As
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
Property RRS2FreePlaySimStepSize() As
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
Property RRS2MainTaskProcessing() As
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
Property RRS2MotionPlannerActiveDuringTeachOLP() As
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
Property RRS2SimRunDownloaders() As
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
Property RRS2StopVRCWhenSimStops() As
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
Property RRS2UpdateProgramOnDownload() As
Gets value of "RRS2UpdateProgramOnDownload" parameter.
Role: Gets value of "RRS2UpdateProgramOnDownload" parameter.
Parameters:
oRRS2UpdateProgramOnDownload
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
Property RRS2UseVRCInverseKinematics() As
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
Property RRS2UseVRCTurnLimits() As
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
Property RRSLibDir() As
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
Property RRSServerFile() As
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

Methods


Sub AddNewRRS2ControllerIdentifier( iControllerIdentifier)
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
Func GetRCSDataLibDirInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RCSDATA$LIB" parameter.
Role:Retrieves the state of the "RCSDATA$LIB" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2ConnectDownloadersInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2ConnectDownloaders" parameter.
Role:Retrieves the state of the "RRS2ConnectDownloaders" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2ConsistencyCmdDownloadersInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2ConsistencyCmdDownloaders" parameter.
Role:Retrieves the state of the "RRS2ConsistencyCmdDownloaders" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Sub GetRRS2ControllerIdentifierAttributes( iControllerIdentifier, oRRS2ConnectDownloader, oRRS2SimRunDownloader, oRRS2ConsistencyCmdDownloader, oRRS2DownloadDuringConnect, oRRS2DownloadDuringSimRun, oRRS2UpdateProgramOnDownload, oRRS2DownloadInPartCoordinates)
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
Func GetRRS2ControllerIdentifiersInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2ControllerIdentifiers" parameter.
Role:Retrieves the state of the "RRS2ControllerIdentifiers" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2DeleteAutoDownloadFilesAfterXferInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
Role:Retrieves the state of the "RRS2DeleteAutoDownloadFilesAfterXfer" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2DfltControllerIdentifierInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2DfltControllerIdentifier" parameter.
Role:Retrieves the state of the "RRS2DfltControllerIdentifier" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2DownloadDuringConnectInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2DownloadDuringConnect" parameter.
Role:Retrieves the state of the "RRS2DownloadDuringConnect" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2DownloadDuringSimRunInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2DownloadDuringSimRun" parameter.
Role:Retrieves the state of the "RRS2DownloadDuringSimRun" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2DownloadInPartCoordinatesInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2DownloadInPartCoordinates" parameter.
Role:Retrieves the state of the "RRS2DownloadInPartCoordinates" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2DownloadLogFileNameInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2DownloadLogFileName" parameter.
Role:Retrieves the state of the "RRS2DownloadLogFileName" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2FreePlaySimStepSizeInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2FreePlaySimStepSize" parameter.
Role:Retrieves the state of the "RRS2FreePlaySimStepSize" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2MainTaskProcessingInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2MainTaskProcessing" parameter.
Role:Retrieves the state of the "RRS2MainTaskProcessing" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2MotionPlannerActiveDuringTeachOLPInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
Role:Retrieves the state of the "RRS2MotionPlannerActiveDuringTeachOLP" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2SimRunDownloadersInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2SimRunDownloaders" parameter.
Role:Retrieves the state of the "RRS2SimRunDownloaders" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2StopVRCWhenSimStopsInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2StopVRCWhenSimStops" parameter.
Role:Retrieves the state of the "RRS2StopVRCWhenSimStops" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2UpdateProgramOnDownloadInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2UpdateProgramOnDownload" parameter.
Role:Retrieves the state of the "RRS2UpdateProgramOnDownload" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2UseVRCInverseKinematicsInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2UseVRCInverseKinematics" parameter.
Role:Retrieves the state of the "RRS2UseVRCInverseKinematics" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRS2UseVRCTurnLimitsInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS2UseVRCTurnLimits" parameter.
Role:Retrieves the state of the "RRS2UseVRCTurnLimits" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRSLibDirInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS$LIB" parameter.
Role:Retrieves the state of the "RRS$LIB" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Func GetRRSServerFileInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the "RRS Servers File" parameter.
Role:Retrieves the state of the "RRS Servers File" parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Sub SetRCSDataLibDirLock( iLocked)
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
Sub SetRRS2ConnectDownloadersLock( iLocked)
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
Sub SetRRS2ConsistencyCmdDownloadersLock( iLocked)
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
Sub SetRRS2ControllerIdentifiersLock( iLocked)
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
Sub SetRRS2DeleteAutoDownloadFilesAfterXferLock( iLocked)
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
Sub SetRRS2DfltControllerIdentifierLock( iLocked)
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
Sub SetRRS2DownloadDuringConnectLock( iLocked)
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
Sub SetRRS2DownloadDuringSimRunLock( iLocked)
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
Sub SetRRS2DownloadInPartCoordinatesLock( iLocked)
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
Sub SetRRS2DownloadLogFileNameLock( iLocked)
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
Sub SetRRS2FreePlaySimStepSizeLock( iLocked)
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
Sub SetRRS2MainTaskProcessingLock( iLocked)
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
Sub SetRRS2MotionPlannerActiveDuringTeachOLPLock( iLocked)
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
Sub SetRRS2SimRunDownloadersLock( iLocked)
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
Sub SetRRS2StopVRCWhenSimStopsLock( iLocked)
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
Sub SetRRS2UpdateProgramOnDownloadLock( iLocked)
Locks or unlocks the "RRS2UpdateProgramOnDownload" parameter.
Role: Locks or unlocks the "RRS2UpdateProgramOnDownload" 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
Sub SetRRS2UseVRCInverseKinematicsLock( iLocked)
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
Sub SetRRS2UseVRCTurnLimitsLock( iLocked)
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
Sub SetRRSLibDirLock( iLocked)
Locks or unlocks the "RRS$LIB" parameter.
Role:Locks or unlocks the "RRS$LIB" parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Sub SetRRSServerFileLock( iLocked)
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