[#wallet-CCoinControl]
= xref:wallet.adoc[wallet]::CCoinControl
:relfileprefix: ../
:mrdocs:

Coin Control Features.

== Synopsis

Declared in `<wallet/coincontrol.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class CCoinControl;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:wallet/CCoinControl/2constructor.adoc[`CCoinControl`]         [.small]#[constructor]#
| Construct a coin control with default settings.
| xref:wallet/CCoinControl/GetExternalOutput.adoc[`GetExternalOutput`] 
| Returns the external output for the given outpoint if it exists.
| xref:wallet/CCoinControl/GetInputWeight.adoc[`GetInputWeight`] 
| Returns the input weight.
| xref:wallet/CCoinControl/GetScripts.adoc[`GetScripts`] 
| Retrieves the scriptSig and scriptWitness for an input.
| xref:wallet/CCoinControl/GetSelectionPos.adoc[`GetSelectionPos`] 
| Returns the selection order position stored for the given pre‐selected output, if any.
| xref:wallet/CCoinControl/GetSequence.adoc[`GetSequence`] 
| Retrieve the sequence for an input
| xref:wallet/CCoinControl/HasSelected.adoc[`HasSelected`] 
| Returns true if there are pre‐selected inputs.
| xref:wallet/CCoinControl/HasSelectedOrder.adoc[`HasSelectedOrder`] 
| Returns true if any pre‐selected input has a stored selection order position.
| xref:wallet/CCoinControl/IsExternalSelected.adoc[`IsExternalSelected`] 
| Returns true if the given output is selected as an external input.
| xref:wallet/CCoinControl/IsSelected.adoc[`IsSelected`] 
| Returns true if the given output is pre‐selected.
| xref:wallet/CCoinControl/ListSelected.adoc[`ListSelected`] 
| List the selected inputs.
| xref:wallet/CCoinControl/Select.adoc[`Select`] 
| Lock‐in the given output for spending. The output will be included in the transaction even if it's not the most optimal choice.
| xref:wallet/CCoinControl/SetInputWeight.adoc[`SetInputWeight`] 
| Set an input's weight.
| xref:wallet/CCoinControl/UnSelect.adoc[`UnSelect`] 
| Unselects the given output.
| xref:wallet/CCoinControl/UnSelectAll.adoc[`UnSelectAll`] 
| Unselects all outputs.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:wallet/CCoinControl/destChange.adoc[`destChange`] 
| Custom change destination, if not set an address is generated
| xref:wallet/CCoinControl/fOverrideFeeRate.adoc[`fOverrideFeeRate`] 
| Override automatic min/max checks on fee, m_feerate must be set if true
| xref:wallet/CCoinControl/m_allow_other_inputs.adoc[`m_allow_other_inputs`] 
| If true, the selection process can add extra unselected inputs from the wallet while requires all selected inputs be used
| xref:wallet/CCoinControl/m_avoid_address_reuse.adoc[`m_avoid_address_reuse`] 
| Forbids inclusion of dirty (previously used) addresses
| xref:wallet/CCoinControl/m_avoid_partial_spends.adoc[`m_avoid_partial_spends`] 
| Avoid partial use of funds sent to a given address
| xref:wallet/CCoinControl/m_change_type.adoc[`m_change_type`] 
| Override the default change type if set, ignored if destChange is set
| xref:wallet/CCoinControl/m_confirm_target.adoc[`m_confirm_target`] 
| Override the default confirmation target if set
| xref:wallet/CCoinControl/m_external_provider.adoc[`m_external_provider`] 
| SigningProvider that has pubkeys and scripts to do spend size estimation for external inputs
| xref:wallet/CCoinControl/m_fee_mode.adoc[`m_fee_mode`] 
| Fee estimation mode.
| xref:wallet/CCoinControl/m_feerate.adoc[`m_feerate`] 
| Override the wallet's fee rate if set
| xref:wallet/CCoinControl/m_include_unsafe_inputs.adoc[`m_include_unsafe_inputs`] 
| If false, only safe inputs will be used
| xref:wallet/CCoinControl/m_locktime.adoc[`m_locktime`] 
| Locktime
| xref:wallet/CCoinControl/m_max_depth.adoc[`m_max_depth`] 
| Maximum chain depth value for coin availability
| xref:wallet/CCoinControl/m_max_tx_weight.adoc[`m_max_tx_weight`] 
| Caps weight of resulting tx
| xref:wallet/CCoinControl/m_min_depth.adoc[`m_min_depth`] 
| Minimum chain depth value for coin availability
| xref:wallet/CCoinControl/m_signal_bip125_rbf.adoc[`m_signal_bip125_rbf`] 
| Override the wallet's m_signal_rbf if set
| xref:wallet/CCoinControl/m_version.adoc[`m_version`] 
| Version
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#