IPXV_Inst::AsyncDo Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(14 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::AsyncDo Method}} | {{#customTitle:IPXV_Inst::AsyncDo Method}} | ||
+ | {{#parentPage:PXV:IPXV_Inst#Methods|AsyncDo|method}} | ||
+ | {{ToReview}} | ||
− | + | This method executes the specified operation in background thread. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT AsyncDo([in] IOperation* pOp, [in, | + | <pre class="brush:cpp;gutter:false">HRESULT AsyncDo([in] IOperation* pOp, |
+ | [in, defaultvalue(0)] ULONG nOpExecFlags, | ||
+ | [in, defaultvalue(NULL)] IPXV_AsyncDoCallback* pAsyncDoCb);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;pOp |
− | :[in] Pointer to [[PXV:IOperation|IOperation]]. | + | :[in] Pointer to [[PXV:IOperation|IOperation]] object. The [[PXV:IOperation_Do|IOperation::Do]] function will be called in background thread. |
− | ; | + | ;nOpExecFlags |
− | :[in, | + | :[in, defaultvalue(0)] The set of [[PXV:OpExecFlags|OpExecFlags]]. This parameter is optional and can be <tt>0</tt>. |
− | ; | + | ;pAsyncDoCb |
− | :[in, | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:IPXV_AsyncDoCallback|IPXV_AsyncDoCallback]]. You may implement object with this callback interface and pass there to catch moment when your specified operation is started/finished in the background thread. This parameter is optional and can be <tt>NULL</tt>. |
== Return Value == | == Return Value == | ||
− | Returns S_OK if operation was successful or error code in other cases. | + | Returns <code>S_OK</code> if operation was successful or error code in other cases. |
== See Also == | == See Also == | ||
− | + | [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_AsyncDoAndWaitForFinish|IPXV_Inst::AsyncDoAndWaitForFinish]] |
Latest revision as of 03:55, 15 June 2015
This method executes the specified operation in background thread.
Syntax
HRESULT AsyncDo([in] IOperation* pOp, [in, defaultvalue(0)] ULONG nOpExecFlags, [in, defaultvalue(NULL)] IPXV_AsyncDoCallback* pAsyncDoCb);
Parameters
- pOp
- [in] Pointer to IOperation object. The IOperation::Do function will be called in background thread.
- nOpExecFlags
- [in, defaultvalue(0)] The set of OpExecFlags. This parameter is optional and can be 0.
- pAsyncDoCb
- [in, defaultvalue(NULL)] Pointer to IPXV_AsyncDoCallback. You may implement object with this callback interface and pass there to catch moment when your specified operation is started/finished in the background thread. This parameter is optional and can be NULL.
Return Value
Returns S_OK
if operation was successful or error code in other cases.