PDFPassword (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

PDFPassword (Function)

In french: PDFMotDePasse

Protects and encrypts a PDF document with a password. A new encrypted PDF document with the specified password is created. This password will be requested when opening the PDF file.

Versions 25 and later

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

New in version 25

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

Example

IF NOT PDFPassword("clear.pdf", "encrypt.pdf", iProtectionDefault, "password") THEN
Error(ErrorInfo())
END

Syntax

<Result> = PDFPassword(<Source PDF file> , <Result PDF file> , <Options> , <Password> [, <Protection password>])

<Result>: Boolean

True if the protection is applied,
False if a problem occurred. ErrorInfo returns the details of the error.

<Source PDF file>: Character string (with quotes)

Name and full path of the PDF file to protect.
Remark: This PDF file must not already be password-protected.

<Result PDF file>: Character string (with quotes)

Name and full path of the protected PDF file.

<Options>: Integer constant (or combination of constants)

Available protection options:
iProtectionComment Protection against the addition or modification of comments.
iProtectionDefault Protection by default: the pdf file is encrypted with the password without any additional protection.
iProtectionPrinting The PDF file cannot be printed.
iProtectionModification The content of PDF file cannot be modified.
iProtectionSelection The content of PDF file cannot be copied or extracted from the file.

<Password>: Character string (with quotes)

Password used to open the PDF file. This password allows you to decrypt the PDF file to read it while respecting the permissions set in the <Options> parameter.
This password cannot contain Unicode characters.

<Protection password>: Optional character string (with quotes)

Password used to allow the modification of the protection options for the PDF file. If this password is used, the protection options specified in the <Options> parameters will not be taken into account.
This password cannot contain Unicode characters.

Business / UI classification: Business Logic

Component: wd260wdpdf.dll