IPXV_DocHighlighter::Add Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_DocHighlighter::Add Method}}
 
{{#customTitle:IPXV_DocHighlighter::Add Method}}
 +
{{#parentPage:PXV:IPXV_DocHighlighter#Methods|Add|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Add([in] IUnknown* pObj, [in] IUnknown* pRegions, [in, optional] IUIX_Brush* pBrush, [in, optional] IUIX_Pen* pPen, [in, optional] PXV_DocHighlightAdvanced* pAdvanced, [in, optional] ULONG nFlags, [out, retval, optional] IPXV_DocHighlightItem** ppRes);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Add([in]                               IUnknown*                 pObj,
 +
            [in]                               IUnknown*                 pRegions,
 +
            [in, defaultvalue(NULL)]           IUIX_Brush*               pBrush,
 +
            [in, defaultvalue(NULL)]           IUIX_Pen*                 pPen,
 +
            [in, defaultvalue(NULL)]           PXV_DocHighlightAdvanced* pAdvanced,
 +
            [in, defaultvalue(0)]             ULONG                     nFlags,
 +
            [out, retval, defaultvalue(NULL)] IPXV_DocHighlightItem**   pRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pObj''
+
;pObj
 
:[in]  Pointer to IUnknown*.
 
:[in]  Pointer to IUnknown*.
;''pRegions''
+
;pRegions
 
:[in]  Pointer to IUnknown*.
 
:[in]  Pointer to IUnknown*.
;''pBrush''
+
;pBrush
:[in, optional]  Pointer to [[PXV:IUIX_Brush|IUIX_Brush]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_Brush|IUIX_Brush]].
;''pPen''
+
;pPen
:[in, optional]  Pointer to [[PXV:IUIX_Pen|IUIX_Pen]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_Pen|IUIX_Pen]].
;''pAdvanced''
+
;pAdvanced
:[in, optional]  Pointer to [[PXV:PXV_DocHighlightAdvanced|PXV_DocHighlightAdvanced]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXV_DocHighlightAdvanced|PXV_DocHighlightAdvanced]].
;''nFlags''
+
;nFlags
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG.
;''ppRes''
+
;pRes
:[out, retval, optional]  Pointer to [[PXV:IPXV_DocHighlightItem|IPXV_DocHighlightItem]].
+
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IPXV_DocHighlightItem|IPXV_DocHighlightItem]].
  
 
== Return Value ==
 
== Return Value ==
Line 27: Line 37:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_DocHighlighter|IPXV_DocHighlighter]].
+
[[PXV:IPXV_DocHighlighter|IPXV_DocHighlighter]]

Latest revision as of 03:51, 15 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT Add([in]                               IUnknown*                  pObj,
            [in]                               IUnknown*                  pRegions,
            [in, defaultvalue(NULL)]           IUIX_Brush*                pBrush,
            [in, defaultvalue(NULL)]           IUIX_Pen*                  pPen,
            [in, defaultvalue(NULL)]           PXV_DocHighlightAdvanced*  pAdvanced,
            [in, defaultvalue(0)]              ULONG                      nFlags,
            [out, retval, defaultvalue(NULL)]  IPXV_DocHighlightItem**    pRes);

Parameters

pObj
[in] Pointer to IUnknown*.
pRegions
[in] Pointer to IUnknown*.
pBrush
[in, defaultvalue(NULL)] Pointer to IUIX_Brush.
pPen
[in, defaultvalue(NULL)] Pointer to IUIX_Pen.
pAdvanced
[in, defaultvalue(NULL)] Pointer to PXV_DocHighlightAdvanced.
nFlags
[in, defaultvalue(0)] Value of ULONG.
pRes
[out, retval, defaultvalue(NULL)] Pointer to IPXV_DocHighlightItem.

Return Value

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

See Also

IPXV_DocHighlighter