Class VerificationResult

The result of a verification operation performed on a digital signature.

Inheritance

object

VerificationResult

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: pdftron.PDF

Assembly: PDFTronDotNet.dll

Syntax

public class VerificationResult : IDisposable

Constructors

VerificationResult(IntPtr, object)

Declaration

public VerificationResult(IntPtr impl_ptr, object reference)

Parameters

Type	Name	Description
IntPtr	impl_ptr
object	reference

Methods

Destroy()

Declaration

public void Destroy()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~VerificationResult()

Declaration

protected ~VerificationResult()

GetDigestAlgorithm()

Retrieves an enumeration value representing the digest algorithm used to sign the signature that is associated with this verification result. For DocTimeStamp signatures, returns the weakest algorithm found (between the CMS and message imprint digests).

Declaration

public DigestAlgorithm.Type GetDigestAlgorithm()

Returns

Type	Description
DigestAlgorithm.Type	A DigestAlgorithm enumeration value

GetDigestStatus()

Retrieves the digest-related result condition associated with a digital signature verification operation.

Declaration

public VerificationResult.DigestStatus GetDigestStatus()

Returns

Type	Description
VerificationResult.DigestStatus	A DigestStatus-type enumeration value

GetDigestStatusAsString()

Retrieves the digest-related result condition associated with a digital signature verification operation, as a descriptive string.

Declaration

public string GetDigestStatusAsString()

Returns

Type	Description
string	a string

GetDigitalSignatureField()

Retrieves the digital signature field associated with the digital signature verification operation that returned this result.

Declaration

public DigitalSignatureField GetDigitalSignatureField()

Returns

Type	Description
DigitalSignatureField	A DigitalSignatureField object

GetDisallowedChanges()

Retrieves a list of informational structures regarding any disallowed changes that have been made to the document since the signature associated with this verification result was signed.

Declaration

public DisallowedChange[] GetDisallowedChanges()

Returns

Type	Description
DisallowedChange[]	a collection of DisallowedChange objects.

GetDocumentStatus()

Retrieves the document-related result condition associated with a digital signature verification operation.

Declaration

public VerificationResult.DocumentStatus GetDocumentStatus()

Returns

Type	Description
VerificationResult.DocumentStatus	A DocumentStatus-type enumeration value

GetDocumentStatusAsString()

Retrieves the document-related result condition associated with a digital signature verification operation, as a descriptive string.

Declaration

public string GetDocumentStatusAsString()

Returns

Type	Description
string	a string

GetPermissionsStatus()

Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation.

Declaration

public VerificationResult.ModificationPermissionsStatus GetPermissionsStatus()

Returns

Type	Description
VerificationResult.ModificationPermissionsStatus	A ModificationPermissionsStatus-type enumeration value

GetPermissionsStatusAsString()

Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation, as a descriptive string.

Declaration

public string GetPermissionsStatusAsString()

Returns

Type	Description
string	a string

GetRefHandleInternal()

Declaration

public object GetRefHandleInternal()

Returns

Type	Description
object

GetTrustStatus()

Retrieves the trust-related result condition associated with a digital signature verification operation.

Declaration

public VerificationResult.TrustStatus GetTrustStatus()

Returns

Type	Description
VerificationResult.TrustStatus	A TrustStatus-type enumeration value

GetTrustStatusAsString()

Retrieves the trust-related result condition associated with a digital signature verification operation, as a descriptive string.

Declaration

public string GetTrustStatusAsString()

Returns

Type	Description
string	a string

GetTrustVerificationResult()

Retrieves the detailed result associated with the trust step of the verification operation that returned this VerificationResult, if such a detailed trust result is available. Must call HasTrustVerificationResult first and check for a true result.

Declaration

public TrustVerificationResult GetTrustVerificationResult()

Returns

Type	Description
TrustVerificationResult	An optional TrustVerificationResult

GetUnsupportedFeatures()

Retrieves reports about unsupported features encountered during verification. This function is the canonical source of information about all unsupported features encountered. Current possible values: "unsupported signature encoding", "usage rights signature", "legal content attestations", "unsupported digest algorithm"

Declaration

public string[] GetUnsupportedFeatures()

Returns

Type	Description
string[]	a container of strings representing unsupported features encountered during verification

Remarks

Output may change in future versions.

GetVerificationStatus()

Retrieves the main verification status. The main status is determined based on the other statuses. Verification may fail for many reasons; some of these reasons are the presence of features that are not supported yet. It may be desirable for you to report unsupported signatures differently (for example, using a question mark rather than an X mark). Any unsupported features encountered can be retrieved by the use of the function GetUnsupportedFeatures on this class.

Declaration

public bool GetVerificationStatus()

Returns

Type	Description
bool	A boolean representing whether or not the verification operation was completely successful

HasTrustVerificationResult()

Returns whether there is a detailed TrustVerificationResult in this VerificationResult or not.

Declaration

public bool HasTrustVerificationResult()

Returns

Type	Description
bool	A boolean

Implements

IDisposable