IPXV_Inst::GetDlgParentWindow Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXV_Inst::GetDlgParentWindow Method}}
 
{{#customTitle:IPXV_Inst::GetDlgParentWindow Method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|GetDlgParentWindow|method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|GetDlgParentWindow|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{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 ==
Line 14: Line 13:
 
== 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 returns 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
 
;pWindow
:[out, retval]  Pointer to HANDLE_T.
+
:[out, retval]  Returns the handle to the optimal parent window.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 18:12, 24 May 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*       pWindow);

Parameters

pRDoc
[in] The optional pointer to IPXC_Document. If you have a document - pass it here, and the function returns 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
[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