task_options Class (Concurrency Runtime)

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

Represents the allowed options for creating a task

class task_options;

Public Constructors

NameDescription
task_options::task_options Constructor (Concurrency Runtime)Overloaded. Default list of task creation options

Public Methods

NameDescription
task_options::get_cancellation_token Method (Concurrency Runtime)Returns the cancellation token
task_options::get_continuation_context Method (Concurrency Runtime)Returns the continuation context
task_options::get_scheduler Method (Concurrency Runtime)Returns the scheduler
task_options::has_cancellation_token Method (Concurrency Runtime)Indicates whether a cancellation token was specified by the user
task_options::has_scheduler Method (Concurrency Runtime)Indicates whether a scheduler n was specified by the user
task_options::set_cancellation_token Method (Concurrency Runtime)Sets the given token in the options
task_options::set_continuation_context Method (Concurrency Runtime)Sets the given continuation context in the options

task_options

Header: ppltasks.h

Namespace: concurrency

Returns the cancellation token

cancellation_token get_cancellation_token() const;

Return Value

Returns the continuation context

task_continuation_context get_continuation_context() const;

Return Value

Returns the scheduler

scheduler_ptr get_scheduler() const;

Return Value

Indicates whether a cancellation token was specified by the user

bool has_cancellation_token() const;

Return Value

Indicates whether a scheduler n was specified by the user

bool has_scheduler() const;

Return Value

Sets the given token in the options

void set_cancellation_token(cancellation_token _Token);

Parameters

_Token

Sets the given continuation context in the options

void set_continuation_context(task_continuation_context _ContinuationContext);

Parameters

_ContinuationContext

Default list of task creation options

task_options();

task_options(
    cancellation_token _Token);

task_options(
    task_continuation_context _ContinuationContext);

task_options(
    cancellation_token _Token,
    task_continuation_context _ContinuationContext);

template<typename _SchedType>
task_options(
    std::shared_ptr<_SchedType> _Scheduler);

task_options(
    scheduler_interface& _Scheduler);

task_options(
    scheduler_ptr _Scheduler);

task_options(
    const task_options& _TaskOptions);

Parameters

_SchedType
_Token
_ContinuationContext
_Scheduler
_TaskOptions

concurrency Namespace

Show: