IPXV_FormatConverter::ShowPrefsDlg Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_FormatConverter::ShowPrefsDlg Method}}
 
{{#customTitle:IPXV_FormatConverter::ShowPrefsDlg Method}}
 +
{{#parentPage:PXV:IPXV_FormatConverter#Methods|ShowPrefsDlg|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Shows the preferences dialog that allows the end-user to modify the advanced cab parameters for the converter.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ShowPrefsDlg([in] IPXV_Inst* pInst, [in] ICab* pParams, [in, optional] ULONG_PTR hWndParent, [in, optional] IUnknown* pSrc, [in, optional] ULONG nFlags);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ShowPrefsDlg([in]                     IPXV_Inst* pInst,
 +
                    [in]                     ICab*       pParams,
 +
                    [in, defaultvalue(0)]     HANDLE_T    hWndParent,
 +
                    [in, defaultvalue(NULL)] IUnknown*   pSrc,
 +
                    [in, defaultvalue(0)]     ULONG       nFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pInst''
+
;pInst
:[in]  Pointer to [[PXV:IPXV_Inst|IPXV_Inst]].
+
:[in]  Pointer to [[PXV:IPXV_Inst|IPXV_Inst]] containing the instance of the program.
;''pParams''
+
;pParams
:[in]  Pointer to [[PXV:ICab|ICab]].
+
:[in]  Pointer to [[PXV:ICab|ICab]] containing the parameters that will be modified. These parameters shoudld be read by the dialog and displayed to the end-user so that he can change and save them before using the converter.
;''hWndParent''
+
;hWndParent
:[in, optional]  Value of ULONG_PTR.
+
:[in, defaultvalue(0)]  Value of HANDLE_T containing the parent window's handle that will be used for the dialog.
;''pSrc''
+
;pSrc
:[in, optional]  Pointer to IUnknown*.
+
:[in, optional]  Pointer to IUnknown* containing the source data, used for the converter.
;''nFlags''
+
;nFlags
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXV_FmtCheckFlags|format check flags]].
  
 
== Return Value ==
 
== Return Value ==
Line 23: Line 30:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_FormatConverter|IPXV_FormatConverter]].
+
[[PXV:IPXV_FormatConverter|IPXV_FormatConverter]]

Latest revision as of 00:41, 27 April 2017


Shows the preferences dialog that allows the end-user to modify the advanced cab parameters for the converter.

Syntax

HRESULT ShowPrefsDlg([in]                      IPXV_Inst*  pInst,
                     [in]                      ICab*       pParams,
                     [in, defaultvalue(0)]     HANDLE_T    hWndParent,
                     [in, defaultvalue(NULL)]  IUnknown*   pSrc,
                     [in, defaultvalue(0)]     ULONG       nFlags);

Parameters

pInst
[in] Pointer to IPXV_Inst containing the instance of the program.
pParams
[in] Pointer to ICab containing the parameters that will be modified. These parameters shoudld be read by the dialog and displayed to the end-user so that he can change and save them before using the converter.
hWndParent
[in, defaultvalue(0)] Value of HANDLE_T containing the parent window's handle that will be used for the dialog.
pSrc
[in, optional] Pointer to IUnknown* containing the source data, used for the converter.
nFlags
[in, defaultvalue(0)] Value of ULONG containing the format check flags.

Return Value

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

See Also

IPXV_FormatConverter