IPXC_Document::SetStdEncryption Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IPXC_Document::SetStdEncryption Method}} | {{#customTitle:IPXC_Document::SetStdEncryption Method}} | ||
{{#parentPage:PXV:IPXC_Document#Methods|SetStdEncryption|method}} | {{#parentPage:PXV:IPXC_Document#Methods|SetStdEncryption|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Sets the encryption of the document. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT SetStdEncryption([in] PXC_StdEncryptionMehtod | + | <pre class="brush:cpp;gutter:false">HRESULT SetStdEncryption([in] PXC_StdEncryptionMehtod nMethod, |
| − | [in] VARIANT_BOOL | + | [in] VARIANT_BOOL bEncryptMetadata, |
| − | [in] ULONG | + | [in] ULONG nPermission, |
| − | [in] BSTR | + | [in] BSTR sUserPassword, |
| − | [in] BSTR | + | [in] BSTR sOwnerPassword);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;nMethod |
| − | :[in] Value of [[PXV:PXC_StdEncryptionMehtod|PXC_StdEncryptionMehtod]]. | + | :[in] Value of [[PXV:PXC_StdEncryptionMehtod|PXC_StdEncryptionMehtod]] containing the type of the encryption. |
| − | ; | + | ;bEncryptMetadata |
| − | :[in] Value of VARIANT_BOOL. | + | :[in] Value of VARIANT_BOOL representing whether the metadata should be encrypted. |
| − | ; | + | ;nPermission |
| − | :[in] Value of ULONG. | + | :[in] Value of ULONG containing the [[PXV:PXC_SecurityPermissions|security permissions flags]]. |
| − | ; | + | ;sUserPassword |
| − | :[in] Value of BSTR. | + | :[in] Value of BSTR containing the user's password. |
| − | ; | + | ;sOwnerPassword |
| − | :[in] Value of BSTR. | + | :[in] Value of BSTR containing the owner's password. |
== Return Value == | == Return Value == | ||
Latest revision as of 07:21, 2 November 2016
Sets the encryption of the document.
Syntax
HRESULT SetStdEncryption([in] PXC_StdEncryptionMehtod nMethod,
[in] VARIANT_BOOL bEncryptMetadata,
[in] ULONG nPermission,
[in] BSTR sUserPassword,
[in] BSTR sOwnerPassword);
Parameters
- nMethod
- [in] Value of PXC_StdEncryptionMehtod containing the type of the encryption.
- bEncryptMetadata
- [in] Value of VARIANT_BOOL representing whether the metadata should be encrypted.
- nPermission
- [in] Value of ULONG containing the security permissions flags.
- sUserPassword
- [in] Value of BSTR containing the user's password.
- sOwnerPassword
- [in] Value of BSTR containing the owner's password.
Return Value
Returns S_OK if operation was successful or error code in other cases.
