IPXV_ImportConverter::Convert Method

From Tracker Software PDF SDK
Revision as of 00:35, 27 April 2017 by Palamar (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Converts the given data to the IPXC_Document if the data format is supported by the converter.

Syntax

HRESULT Convert([in]                      IPXV_Inst*       pInst,
                [in]                      IUnknown*        pSrc,
                [in, defaultvalue(0)]     ULONG            nFlags,
                [in, defaultvalue(NULL)]  ICab*            pParams,
                [in, defaultvalue(NULL)]  IProgressMon*    pProgress,
                [in, defaultvalue(0)]     HANDLE_T         hWndParent,
                [in, defaultvalue(NULL)]  IUnknown*        pCtx,
                [out, retval]             IPXC_Document**  pDoc);

Parameters

pInst
[in] Pointer to 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, defaultvalue(0)] Value of ULONG containing the format check flags.
pParams
[in, defaultvalue(NULL)] Pointer to ICab containing the advanced format details cab node.
pProgress
[in, defaultvalue(NULL)] Pointer to IProgressMon containing the custom progress monitor.
hWndParent
[in, defaultvalue(0)] Value of HANDLE_T containing the parent window handle.
pCtx
[in, defaultvalue(NULL)] Pointer to IUnknown* containing an additional convertor's context.
pDoc
[out, retval] Pointer to IPXC_Document containing the resulting document when the conversion was successful.

Return Value

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

See Also

IPXV_ImportConverter