1. Home
  2. API
  3. Broadside.Security
  4. PdfPasswordException

PdfPasswordException Class

Definition

Assembly Broadside.dll
Inherits Object → Exception
Implements ISerializable
View source
Show inherited members (18)

The exception thrown when an encrypted document cannot be opened with the password given.

public sealed class PdfPasswordException : Exception, ISerializable

Remarks

ISO 32000-2 §7.6.4.1: a reader first tries the default (empty) user password and, when that fails, should prompt for a password. Failure tells the two cases apart, so a caller can prompt on Required and report a typing mistake on Incorrect.

Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Constructors (4)

PdfPasswordException()Initializes a new instance of the PdfPasswordException class.
PdfPasswordException(PdfPasswordFailure)Initializes a new instance of the PdfPasswordException class.
PdfPasswordException(String?, Exception?)Initializes a new instance of the PdfPasswordException class.
PdfPasswordException(String?)Initializes a new instance of the PdfPasswordException class.

Properties (1)

FailureGets why the password did not open the document.