IPXV_Inst::ShowCreateFileErrDlg Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::ShowCreateFileErrDlg Method}}
 
{{#customTitle:IPXV_Inst::ShowCreateFileErrDlg Method}}
{{#parentPage:PXV:IPXV_Inst|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|ShowCreateFileErrDlg|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method displays for end-user the dialog with description of the specified file-creation error and with some advanced options like: ''Retry'', ''Save As'' etc.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ShowCreateFileErrDlg(IAFS_Name* pFileName, HRESULT hErr, [in, defaultvalue(0)] HANDLE_T hWndParent, [in, defaultvalue(0)] LONG nFlags, [out, defaultvalue(NULL)] IAFS_Name** ppNewFileName, [out, retval] LONG* pRes);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ShowCreateFileErrDlg(                           IAFS_Name*   pFileName,
 +
                                                        HRESULT     hErr,
 +
                            [in, defaultvalue(0)]     HANDLE_T     hWndParent,
 +
                            [in, defaultvalue(0)]     LONG         nFlags,
 +
                            [out, defaultvalue(NULL)] IAFS_Name** pNewFileName,
 +
                            [out, retval]             LONG*       pRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pFileName''
+
;pFileName
: Pointer to [[PXV:IAFS_Name|IAFS_Name]].
+
: Pointer to [[PXV:IAFS_Name|IAFS_Name]] object that represents the problematic path.
;''hErr''
+
;hErr
: Value of HRESULT.
+
: Indicates the file-creation error.
;''hWndParent''
+
;hWndParent
:[in, defaultvalue(0)]  Value of HANDLE_T.
+
:[in, defaultvalue(0)]  The optional parameter that specifies the handle of parent window.
;''nFlags''
+
;nFlags
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  The optional value. See [[PXV:PXV_CreateFileErrDlgFlags|PXV_CreateFileErrDlgFlags]].
;''ppNewFileName''
+
;pNewFileName
:[out, defaultvalue(NULL)]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
+
:[out, defaultvalue(NULL)]  When user chooses the ''Save As'' option it may return the pointer to other [[PXV:IAFS_Name|IAFS_Name]] object.
;''pRes''
+
;pRes
:[out, retval]  Pointer to LONG.
+
:[out, retval]  Returns identifier of user choice. Possible values:
 +
::<tt>UIX_No</tt>
 +
::<tt>UIX_Retry</tt>
 +
::<tt>UIX_Cancel</tt>
 +
::that are from [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]] enumeration.
  
 
== Return Value ==
 
== Return Value ==
Line 28: Line 37:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]]

Latest revision as of 03:57, 15 June 2015


The method displays for end-user the dialog with description of the specified file-creation error and with some advanced options like: Retry, Save As etc.

Syntax

HRESULT ShowCreateFileErrDlg(                           IAFS_Name*   pFileName,
                                                        HRESULT      hErr,
                             [in, defaultvalue(0)]      HANDLE_T     hWndParent,
                             [in, defaultvalue(0)]      LONG         nFlags,
                             [out, defaultvalue(NULL)]  IAFS_Name**  pNewFileName,
                             [out, retval]              LONG*        pRes);

Parameters

pFileName
Pointer to IAFS_Name object that represents the problematic path.
hErr
Indicates the file-creation error.
hWndParent
[in, defaultvalue(0)] The optional parameter that specifies the handle of parent window.
nFlags
[in, defaultvalue(0)] The optional value. See PXV_CreateFileErrDlgFlags.
pNewFileName
[out, defaultvalue(NULL)] When user chooses the Save As option it may return the pointer to other IAFS_Name object.
pRes
[out, retval] Returns identifier of user choice. Possible values:
UIX_No
UIX_Retry
UIX_Cancel
that are from UIX_MsgBoxResult enumeration.

Return Value

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

See Also

IPXV_Inst