IPXC_Document::RequestPermission Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(12 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Document::RequestPermission Method}}
 
{{#customTitle:IPXC_Document::RequestPermission Method}}
 +
{{#parentPage:PXV:IPXC_Document#Methods|RequestPermission|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets the requested permission for the needed operation from the document.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT RequestPermission([in] PXC_RequestObj reqObj, [in] PXC_RequestOper reqOper, [in] void* authData, [out, retval] PXC_PermStatus* pStatus);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT RequestPermission([in]                     PXC_RequestObj   nReqObj,
 +
                          [in]                     PXC_RequestOper nReqOper,
 +
                          [in, defaultvalue(NULL)] void*           pAuthData,
 +
                          [out, retval]             PXC_PermStatus* nStatus);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''reqObj''
+
;nReqObj
:[in]  Value of [[PXV:PXC_RequestObj|PXC_RequestObj]].
+
:[in]  Value of [[PXV:PXC_RequestObj|PXC_RequestObj]] containing the object which permission will be requested.
;''reqOper''
+
;nReqOper
:[in]  Value of [[PXV:PXC_RequestOper|PXC_RequestOper]].
+
:[in]  Value of [[PXV:PXC_RequestOper|PXC_RequestOper]] containing the object's operation that should be checked for permission.
;''authData''
+
;pAuthData
:[in]  Pointer to void.
+
:[in, defaultvalue(NULL)]  Pointer to void. ''Currently not implemented''
;''pStatus''
+
;nStatus
:[out, retval]  Pointer to [[PXV:PXC_PermStatus|PXC_PermStatus]].
+
:[out, retval]  Pointer to [[PXV:PXC_PermStatus|PXC_PermStatus]], containing the resulting permission status.
  
 
== Return Value ==
 
== Return Value ==
Line 21: Line 27:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Document|IPXC_Document]].
+
[[PXV:IPXC_Document|IPXC_Document]]

Latest revision as of 01:36, 2 June 2016


Gets the requested permission for the needed operation from the document.

Syntax

HRESULT RequestPermission([in]                      PXC_RequestObj   nReqObj,
                          [in]                      PXC_RequestOper  nReqOper,
                          [in, defaultvalue(NULL)]  void*            pAuthData,
                          [out, retval]             PXC_PermStatus*  nStatus);

Parameters

nReqObj
[in] Value of PXC_RequestObj containing the object which permission will be requested.
nReqOper
[in] Value of PXC_RequestOper containing the object's operation that should be checked for permission.
pAuthData
[in, defaultvalue(NULL)] Pointer to void. Currently not implemented
nStatus
[out, retval] Pointer to PXC_PermStatus, containing the resulting permission status.

Return Value

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

See Also

IPXC_Document