IPXC_Document::RequestPermission Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IPXC_Document::RequestPermission Method}} | {{#customTitle:IPXC_Document::RequestPermission Method}} | ||
{{#parentPage:PXV:IPXC_Document#Methods|RequestPermission|method}} | {{#parentPage:PXV:IPXC_Document#Methods|RequestPermission|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Gets the requested permission for the needed operation from the document. | |
== Syntax == | == Syntax == | ||
| Line 12: | Line 11: | ||
[in] PXC_RequestOper nReqOper, | [in] PXC_RequestOper nReqOper, | ||
[in, defaultvalue(NULL)] void* pAuthData, | [in, defaultvalue(NULL)] void* pAuthData, | ||
| − | [out, retval] PXC_PermStatus* | + | [out, retval] PXC_PermStatus* nStatus);</pre> |
== Parameters == | == Parameters == | ||
;nReqObj | ;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. |
;nReqOper | ;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. |
;pAuthData | ;pAuthData | ||
| − | :[in, defaultvalue(NULL)] Pointer to void. | + | :[in, defaultvalue(NULL)] Pointer to void. ''Currently not implemented'' |
| − | ; | + | ;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 == | ||
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.
