Microsoft Information Protection SDK - C 1.17
API Reference Documentation for C
|
Defines task dispatcher callback functions. More...
#include <stddef.h>
#include <stdint.h>
#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/mip_macros_cc.h"
#include "mip_cc/result_cc.h"
Go to the source code of this file.
Classes | |
struct | mip_cc_async_task |
Defines a single async task dispatch request. More... | |
Typedefs | |
typedef mip_cc_handle * | mip_cc_task_dispatcher_delegate |
Functions | |
MIP_CC_CALLBACK (mip_cc_dispatch_task_callback_fn, void, const mip_cc_async_task *) | |
Callback function definition for dispatching an async task. | |
MIP_CC_CALLBACK (mip_cc_cancel_task_callback_fn, bool, const char *) | |
Callback function for canceling a background tasks. | |
MIP_CC_CALLBACK (mip_cc_cancel_all_tasks_callback_fn, void) | |
Callback function for canceling all background tasks. | |
MIP_CC_API (mip_cc_result) MIP_CC_CreateTaskDispatcherDelegate(const mip_cc_dispatch_task_callback_fn dispatchTaskCallback | |
Creates a task dispatcher delegate which can be used to override MIP's default async task handling. | |
MIP_CC_API (void) MIP_CC_ExecuteDispatchedTask(const mip_cc_task_dispatcher_delegate taskDispatcher | |
Notifies a TaskDispatcher delegate that a task is scheduled to execute now on the current thread. | |
Variables | |
const mip_cc_cancel_task_callback_fn | cancelTaskCallback |
const mip_cc_cancel_task_callback_fn const mip_cc_cancel_all_tasks_callback_fn | cancelAllTasksCallback |
const mip_cc_cancel_task_callback_fn const mip_cc_cancel_all_tasks_callback_fn mip_cc_task_dispatcher_delegate * | taskDispatcher |
const mip_cc_cancel_task_callback_fn const mip_cc_cancel_all_tasks_callback_fn mip_cc_task_dispatcher_delegate mip_cc_error * | errorInfo |
const char * | taskId |
Defines task dispatcher callback functions.
MIP_CC_API | ( | mip_cc_result | ) | const |
Creates a task dispatcher delegate which can be used to override MIP's default async task handling.
dispatchTaskCallback | Function pointer for dispatching async tasks |
cancelTaskCallback | Function pointer for cancelling background tasks |
cancelAllTasksCallback | Function pointer for cancelling all background tasks |
taskDispatcher | [Output] Handle to task dispatcher delegate object |
errorInfo | [Output] (Optional) Failure info if operation result is error |
MIP_CC_API | ( | void | ) | const |
Notifies a TaskDispatcher delegate that a task is scheduled to execute now on the current thread.
Release resources associated with an task dispatcher delegate handle.
taskDispatcher | Handle to task dispatcher delegate object |
taskId | ID of async task associated with this operation |
taskDispatcher | Task dispatcher delegate to be released |
MIP_CC_CALLBACK | ( | mip_cc_cancel_all_tasks_callback_fn | , |
void | ) |
Callback function for canceling all background tasks.
MIP_CC_CALLBACK | ( | mip_cc_cancel_task_callback_fn | , |
bool | , | ||
const char * | ) |
Callback function for canceling a background tasks.
taskId | Unique task identifier |
MIP_CC_CALLBACK | ( | mip_cc_dispatch_task_callback_fn | , |
void | , | ||
const mip_cc_async_task * | ) |
Callback function definition for dispatching an async task.
taskId | Unique task identifier |
const mip_cc_cancel_task_callback_fn const mip_cc_cancel_all_tasks_callback_fn cancelAllTasksCallback |
const mip_cc_cancel_task_callback_fn cancelTaskCallback |
const mip_cc_cancel_task_callback_fn const mip_cc_cancel_all_tasks_callback_fn mip_cc_task_dispatcher_delegate mip_cc_error* errorInfo |
const mip_cc_cancel_task_callback_fn const mip_cc_cancel_all_tasks_callback_fn mip_cc_task_dispatcher_delegate* taskDispatcher |
const char* taskId |