IPXV_Inst::ThreadSafeCall Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::ThreadSafeCall Method}}
 
{{#customTitle:IPXV_Inst::ThreadSafeCall Method}}
{{#parentPage:PXV:IPXV_Inst|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|ThreadSafeCall|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Executes the method [[PXV:IPXV_ThreadSafeCallback_OnThreadSafeCall|OnThreadSafeCall]] of passed [[PXV:IPXV_ThreadSafeCallback|IPXV_ThreadSafeCallback]] object and ensures it will be called in the main thread.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ThreadSafeCall([in] IPXV_ThreadSafeCallback* pCb, [in, defaultvalue(0)] VARIANT_BOOL bWaitWithMsgLoop);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ThreadSafeCall([in]                   IPXV_ThreadSafeCallback* pCb,
 +
                      [in, defaultvalue(0)] VARIANT_BOOL             bWaitWithMsgLoop);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pCb''
+
;pCb
:[in]  Pointer to [[PXV:IPXV_ThreadSafeCallback|IPXV_ThreadSafeCallback]].
+
:[in]  Pointer to [[PXV:IPXV_ThreadSafeCallback|IPXV_ThreadSafeCallback]] interface.
;''bWaitWithMsgLoop''
+
;bWaitWithMsgLoop
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Specify <tt>true</tt> value to make call asynchronous but with message-loop inside caller's thread until method [[PXV:IPXV_ThreadSafeCallback_OnThreadSafeCall|OnThreadSafeCall]] will be finished.
  
 
== Return Value ==
 
== Return Value ==
Line 20: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]]

Latest revision as of 03:58, 15 June 2015


Executes the method OnThreadSafeCall of passed IPXV_ThreadSafeCallback object and ensures it will be called in the main thread.

Syntax

HRESULT ThreadSafeCall([in]                   IPXV_ThreadSafeCallback*  pCb,
                       [in, defaultvalue(0)]  VARIANT_BOOL              bWaitWithMsgLoop);

Parameters

pCb
[in] Pointer to IPXV_ThreadSafeCallback interface.
bWaitWithMsgLoop
[in, defaultvalue(0)] Specify true value to make call asynchronous but with message-loop inside caller's thread until method OnThreadSafeCall will be finished.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst