IPXV_ImportConverter::CheckFormat2 Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXV_ImportConverter::CheckFormat2 Method}}
 
{{#customTitle:IPXV_ImportConverter::CheckFormat2 Method}}
 
{{#parentPage:PXV:IPXV_ImportConverter#Methods|CheckFormat2|method}}
 
{{#parentPage:PXV:IPXV_ImportConverter#Methods|CheckFormat2|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Checks whether the source data is supported by the converter. If the data format is supported - the '''FmtCheckRes_OK''' result is being returned.
  
 
== Syntax ==
 
== Syntax ==
Line 18: Line 17:
 
== Parameters ==
 
== Parameters ==
 
;pInst
 
;pInst
:[in]  Pointer to [[PXV:IPXV_Inst|IPXV_Inst]].
+
:[in]  Pointer to [[PXV:IPXV_Inst| containing the instance of the program.
 
;pSrc
 
;pSrc
:[in]  Pointer to IUnknown*.
+
:[in]  Pointer to IUnknown* containing the source data. This should be cast to the data type that is supported by the converter. For example, the Image to PDF converter checks whether this pointer is an [[PXV:IIXC_Image|IIXC_Image]].
 
;nFlags
 
;nFlags
:[in]  Value of ULONG.
+
:[in]  Value of ULONG containing the [[PXV:PXV_FmtCheckFlags|format check flags]].
 
;pFmtDetails
 
;pFmtDetails
:[out]  Pointer to [[PXV:ICab|ICab]].
+
:[out]  Pointer to [[PXV:ICab|ICab]] containing the advanced format details cab node.
 
;pCheckRes
 
;pCheckRes
:[out]  Pointer to IUnknown*.
+
:[out]  Pointer to IUnknown* containing the additional result data.
 
;pCheckResVal
 
;pCheckResVal
:[out, retval]  Pointer to [[PXV:PXV_FmtCheckResult|PXV_FmtCheckResult]].
+
:[out, retval]  Pointer to [[PXV:PXV_FmtCheckResult|PXV_FmtCheckResult]] containing the format check result.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 01:26, 27 April 2017


Checks whether the source data is supported by the converter. If the data format is supported - the FmtCheckRes_OK result is being returned.

Syntax

HRESULT CheckFormat2([in]           IPXV_Inst*           pInst,
                     [in]           IUnknown*            pSrc,
                     [in]           ULONG                nFlags,
                     [out]          ICab**               pFmtDetails,
                     [out]          IUnknown**           pCheckRes,
                     [out, retval]  PXV_FmtCheckResult*  pCheckResVal);

Parameters

pInst
[in] Pointer to [[PXV:IPXV_Inst| containing the instance of the program.
pSrc
[in] Pointer to IUnknown* containing the source data. This should be cast to the data type that is supported by the converter. For example, the Image to PDF converter checks whether this pointer is an IIXC_Image.
nFlags
[in] Value of ULONG containing the format check flags.
pFmtDetails
[out] Pointer to ICab containing the advanced format details cab node.
pCheckRes
[out] Pointer to IUnknown* containing the additional result data.
pCheckResVal
[out, retval] Pointer to PXV_FmtCheckResult containing the format check result.

Return Value

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

See Also

IPXV_ImportConverter