-
Notifications
You must be signed in to change notification settings - Fork 23
QuantumGate::Extender::SetPreShutdownCallback
Karel Donk edited this page Dec 10, 2019
·
3 revisions
Sets the pre-shutdown callback function. It's only possible to set this callback function when the extender isn't running.
This callback function gets called by the QuantumGate instance hosting the extender right before it's about to shut down the extender. The extender should generally stop any interactions with the QuantumGate instance after returning from this function and may begin shutting down.
It's not required to set this callback function.
Result<> SetPreShutdownCallback(PreShutdownCallback&& function) noexcept;
Name | Description |
---|---|
function |
A QuantumGate::Extender::PreShutdownCallback object containing the function that should be called. See QuantumGate Callbacks for more information. |
Returns a QuantumGate::Result
object equal to one of the following QuantumGate::ResultCode
s:
Value | Description |
---|---|
QuantumGate::ResultCode::Succeeded |
The operation succeeded. |
QuantumGate::ResultCode::Failed |
The operation failed. The extender may have been running. |
QuantumGate::ResultCode::InvalidArgument |
The operation failed because an invalid argument was passed in. |