Xecrets.Sdk.Models.XfFilePair.md

May 26, 2026 · View on GitHub

Xecrets.Sdk

Xecrets.Sdk.Models

XfFilePair Class

A plain text/cipher text file pair

public class XfFilePair

Inheritance System.Object → XfFilePair

Remarks

Create a new instance.

Constructors

XfFilePair(string, string) Constructor

Create a new instance.

public XfFilePair(string sourceFullName, string targetFullName);

Parameters

sourceFullName System.String

The full path and name of the source, cipher text.

targetFullName System.String

The full path and name of the target, plain text.

XfFilePair(string, string, string, bool) Constructor

A plain text/cipher text file pair

public XfFilePair(string sourceFullName, string targetFullName, string originalFileName, bool compressBeforeEncrypt);

Parameters

sourceFullName System.String

The full path and name of the source, plain text.

targetFullName System.String

The full path and name of the target, cipher text.

originalFileName System.String

The original file name to use when encrypting.

compressBeforeEncrypt System.Boolean

True if the file should be compressed before encryption.

Remarks

Create a new instance.

Properties

XfFilePair.CompressBeforeEncrypt Property

True if the file should be compressed before encryption.

public bool CompressBeforeEncrypt { get; set; }

Property Value

System.Boolean

XfFilePair.OriginalFileName Property

The original file name to use when encrypting.

public string OriginalFileName { get; }

Property Value

System.String

XfFilePair.SourceFullName Property

The full path and name of the source, plain text or cipher text.

public string SourceFullName { get; }

Property Value

System.String

XfFilePair.SourceLength Property

The length in bytes of the source file.

public long SourceLength { get; }

Property Value

System.Int64

XfFilePair.TargetFullName Property

The full path and name of the target, plain text or cipher text.

public string TargetFullName { get; }

Property Value

System.String