IPXV_Inst::ModifyDoc Method

From PDF XChange PDF SDK
Jump to: navigation, search
(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::ModifyDoc Method}}
 
{{#customTitle:IPXV_Inst::ModifyDoc Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|ModifyDoc|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method changes document modifications counter. Used to control the modification state for specified document.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ModifyDoc([in] IPXV_Document* pDoc, [in] PXC_DocModifyType nModType, [in, optional] LONG nModCount);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ModifyDoc([in]                   IPXV_Document*     pDoc,
 +
                  [in]                   PXC_DocModifyType nModType,
 +
                  [in, defaultvalue(1)] LONG               nModCount);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pDoc''
+
;pDoc
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]].
+
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]] object.
;''nModType''
+
;nModType
 
:[in]  Value of [[PXV:PXC_DocModifyType|PXC_DocModifyType]].
 
:[in]  Value of [[PXV:PXC_DocModifyType|PXC_DocModifyType]].
;''nModCount''
+
;nModCount
:[in, optionalValue of LONG.
+
:[in, defaultvalue(1)The count of sequential modifications.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_ModifyCoreDoc|IPXV_Inst::ModifyCoreDoc]]

Latest revision as of 02:57, 15 June 2015


The method changes document modifications counter. Used to control the modification state for specified document.

Syntax

HRESULT ModifyDoc([in]                   IPXV_Document*     pDoc,
                  [in]                   PXC_DocModifyType  nModType,
                  [in, defaultvalue(1)]  LONG               nModCount);

Parameters

pDoc
[in] Pointer to IPXV_Document object.
nModType
[in] Value of PXC_DocModifyType.
nModCount
[in, defaultvalue(1)] The count of sequential modifications.

Return Value

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

See Also

IPXV_Inst, IPXV_Inst::ModifyCoreDoc