IOperation::CreateInputItem Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IOperation::CreateInputItem Method}}
 
{{#customTitle:IOperation::CreateInputItem Method}}
{{#parentPage:PXV:IOperation|method}}
+
{{#parentPage:PXV:IOperation#Methods|CreateInputItem|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
Creates wrapper for the input object of the operation. This wrapper allows to pass additional parameters along with the input object.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateInputItem([in] IUnknown* pSrc, [out, retval] IOpInputItem** ppNewInputItem);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateInputItem([in]           IUnknown*       pSrc,
 +
                        [out, retval] IOpInputItem** pNewInputItem);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pSrc''
+
;pSrc
:[in]  Pointer to IUnknown*.
+
:[in]  Pointer to the IUnknown based interface of the input object for the operation.
;''ppNewInputItem''
+
;pNewInputItem
:[out, retval]  Pointer to [[PXV:IOpInputItem|IOpInputItem]].
+
:[out, retval]  Pointer to a buffer, that receives a pointer to the wrapper object.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IOperation|IOperation]].
+
[[PXV:IOperation|IOperation]]

Latest revision as of 23:55, 30 November 2017

Creates wrapper for the input object of the operation. This wrapper allows to pass additional parameters along with the input object.

Syntax

HRESULT CreateInputItem([in]           IUnknown*       pSrc,
                        [out, retval]  IOpInputItem**  pNewInputItem);

Parameters

pSrc
[in] Pointer to the IUnknown based interface of the input object for the operation.
pNewInputItem
[out, retval] Pointer to a buffer, that receives a pointer to the wrapper object.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IOperation