IPXV_Inst::GetDlgParentWindow Method

From PDF XChange PDF SDK
Jump to: navigation, search
(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::GetDlgParentWindow Method}}
 
{{#customTitle:IPXV_Inst::GetDlgParentWindow Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|GetDlgParentWindow|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Returns the handle of window corresponding to the specified document object and that can be used as parent for new dialog displaying.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetDlgParentWindow([in] IPXC_Document* pRDoc, [out, retval] ULONG_PTR* pWindow);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetDlgParentWindow([in]           IPXC_Document* pRDoc,
 +
                          [out, retval] HANDLE_T*       nWindow);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pRDoc''
+
;pRDoc
:[in]  Pointer to [[PXV:IPXC_Document|IPXC_Document]].
+
:[in]  The optional pointer to [[PXV:IPXC_Document|IPXC_Document]]. If you have a document - pass it here, and the function will return the handle of optimal window to be the parent of your dialog. You may pass the NULL value to get window handle of active document view or active main frame at least.
;''pWindow''
+
;nWindow
:[out, retval]  Pointer to ULONG_PTR.
+
:[out, retval]  Returns the handle to the optimal parent window.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]]

Latest revision as of 03:56, 15 June 2015


Returns the handle of window corresponding to the specified document object and that can be used as parent for new dialog displaying.

Syntax

HRESULT GetDlgParentWindow([in]           IPXC_Document*  pRDoc,
                           [out, retval]  HANDLE_T*       nWindow);

Parameters

pRDoc
[in] The optional pointer to IPXC_Document. If you have a document - pass it here, and the function will return the handle of optimal window to be the parent of your dialog. You may pass the NULL value to get window handle of active document view or active main frame at least.
nWindow
[out, retval] Returns the handle to the optimal parent window.

Return Value

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

See Also

IPXV_Inst