QuantumGate::Local::RemoveExtender

Removes an extender from the instance. If the instance is running, the extender is shut down before being removed.

Signature

Result<> RemoveExtender(const std::shared_ptr<Extender>& extender) noexcept;

Parameters

Name	Description
extender	A std::shared_ptr to an object derived from the QuantumGate::Extender class. See QuantumGate::Extender for details.

Return values

Returns a QuantumGate::Result object equal to one of the following QuantumGate::ResultCodes:

Value	Description
QuantumGate::ResultCode::Succeeded	The operation succeeded.
QuantumGate::ResultCode::Failed	The operation failed.
QuantumGate::ResultCode::InvalidArgument	The argument was invalid.
QuantumGate::ResultCode::ExtenderObjectDifferent	The operation failed because the extender object is different from the one that was used to add the extender.
QuantumGate::ResultCode::ExtenderAlreadyRemoved	The operation failed because the extender was already removed.
QuantumGate::ResultCode::ExtenderNotFound	The operation failed because the extender wasn't found.