Skip to main content

Component Plug-In SDK 2026 R1

Method RequireValidStatus

Last update: 19.06.2026

Namespace: Phoenix.ComponentAPI
Assembly: Phoenix.ComponentAPI.dll

RequireValidStatus(RunStatus, string)

Given a run status, check if it is a valid status for a run result. If it is valid, return the provided status. Otherwise, throw an System.ArgumentOutOfRangeException.

public static RunStatus RequireValidStatus(RunStatus candidate, string paramName)

Parameters

candidate RunStatus

The candidate status.

paramName string

The name of the variable containing the status.

Returns

RunStatus

The value of candidate if the status is valid.

Connect with Ansys