Skip to content
Start free evaluation

PDComm.GemFormattedProgramDryRunOptions

Class

The policy version and limits of one formatted process program dry run.

public sealed record GemFormattedProgramDryRunOptions

Pass the options to GemFormattedPrograms.DryRun. A dry run that would exceed a limit fails with PdcommStatus.LimitExceeded instead of returning a partial report.

Parameters

NameDescription
PolicyVersionThe evaluation policy version. Only 1 is supported; other values fail with PdcommStatus.InvalidArgument.
MaxIssuesThe largest number of issues the report may hold.
MaxProgramEncodedBytesThe largest encoded size, in bytes, of the selected process program (its S7F23 body) that the dry run evaluates.

Members

GemFormattedProgramDryRunOptions

Constructor

The policy version and limits of one formatted process program dry run.

public GemFormattedProgramDryRunOptions(uint PolicyVersion, nuint MaxIssues, nuint MaxProgramEncodedBytes)

Pass the options to GemFormattedPrograms.DryRun. A dry run that would exceed a limit fails with PdcommStatus.LimitExceeded instead of returning a partial report.

Parameters

NameDescription
PolicyVersionThe evaluation policy version. Only 1 is supported; other values fail with PdcommStatus.InvalidArgument.
MaxIssuesThe largest number of issues the report may hold.
MaxProgramEncodedBytesThe largest encoded size, in bytes, of the selected process program (its S7F23 body) that the dry run evaluates.

MaxIssues

Property

The largest number of issues the report may hold.

public nuint MaxIssues { get; init; }

MaxProgramEncodedBytes

Property

The largest encoded size, in bytes, of the selected process program (its S7F23 body) that the dry run evaluates.

public nuint MaxProgramEncodedBytes { get; init; }

PolicyVersion

Property

The evaluation policy version. Only 1 is supported; other values fail with PdcommStatus.InvalidArgument.

public uint PolicyVersion { get; init; }