CompreDrive SDK Documentation
CompreDriveSDK
CompreDriveSDK.WCF Namespaces
CompreDriveSDK.WCF
ICompreDriveWCF Interface
ICompreDriveWCF Methods
ApplyDistanceSetpoint Method
ApproachCompreDrive Method
CallPluginCommand Method
CallPluginCommandBoolean Method
CallPluginCommandNumber Method
CallPluginCommandText Method
Connect Method
DisableRamp Method
DisableTemperatureControl Method
Disconnect Method
EnableRamp Method
EnableTemperatureControl Method
GetAllForceUnits Method
GetAllPressureUnits Method
GetAllTemperatureUnits Method
GetCommandPlugins Method
GetCompreDriveState Method
GetCompreFrameForceGross Method
GetCompreFrameForceNet Method
GetConstantDistanceSetpoint Method
GetCurrentUserPath Method
GetDataProvider Method
GetDistanceValue Method
GetForce Method
GetForceAmpForceGross Method
GetForceAmpForceNet Method
GetForceAmpPressureGross Method
GetForceAmpPressureNet Method
GetForceAmpPressureUnit Method
GetForceControlEnabled Method
GetForceSetpoint Method
GetForceUnit Method
GetHWInTrigger Method
GetIdentifier Method
GetIsForceStable Method
GetIsTemperatureStable Method
GetLastFaultCodes Method
GetPluginCommands Method
GetPosition Method
GetPressure Method
GetPressureUnit Method
GetSWOutTrigger Method
GetTemperature Method
GetTemperatureControlEnabled Method
GetTemperatureSetpoint Method
GetTemperatureUnit Method
IsCMDriveConnected Method
IsTControllerConnected Method
PauseRegulation Method
PulseHWOutTrigger Method
RetractCompreDrive Method
SetForceSetpoint Method
SetHWInTriggerMode Method
SetHWOutTriggerMode Method
SetPressureSetpoint Method
SetSWInTrigger Method
SetTemperatureSetpoint Method
StartConstantDistanceMode Method
StopConstantDistanceMode Method
UnpauseRegulation Method
WriteLogMessage Method
Click or drag to resize

ICompreDriveWCFRetractCompreDrive Method

Retracts the CompreDrive back to safe position.

Namespace: CompreDriveSDK.WCF
Assembly: CompreDriveSDK (in CompreDriveSDK.dll) Version: 1.17.16
Syntax
Copy
bool RetractCompreDrive()

Return Value

Boolean
True if the retract was successfully started, false if not.
Remarks
Only works when in Manual Control.
See Also