Skip to main content

Component Plug-In SDK 2026 R1

Method IsValidStatus

Last update: 19.06.2026

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

IsValidStatus(RunStatus)

Given a status, check if it is a valid status for a component run result. The valid statuses are those that indicate that the run is complete - Phoenix.ComponentAPI.RunStatus.SUCCESS, Phoenix.ComponentAPI.RunStatus.FAILED, Phoenix.ComponentAPI.RunStatus.CANCELED.

public static bool IsValidStatus(RunStatus candidate)

Parameters

candidate RunStatus

The candidate status.

Returns

bool

True if the status is valid for a component run result, false otherwise.

Connect with Ansys