C_GetFrequencyDomainProcessComponents3

Call C_GetFrequencyDomainProcessComponents3 to get a list of the model's frequency domain process components for a specified solve type.

void C_GetFrequencyDomainProcessComponents3(

TOrcFxAPIHandle ModelHandle,

int FrequencyDomainSolveType,

int *lpCount,

TFrequencyDomainProcessComponent2 *lpFrequencyDomainProcessComponents,

int *lpStatus

);

Parameters

ModelHandle (IN)

The handle of the model.

FrequencyDomainSolveType (IN)

Specifies which frequency domain solve type the frequency domain process components are returned for. Can be one of the following constants defined in OrcFxAPI.h:

fdstLatest: return components for the latest solve type run, i.e., for low frequency, combined linearisation solution frequencies, the low frequency components will be returned.
fdstWaveFrequency: return the wave frequency components, if available.
fdstLowFrequency: return the low frequency components, if available.

lpCount (OUT)

Points to a variable in which the total number of process components is returned.

lpFrequencyDomainProcessComponents (OUT)

Points to a block of memory to receive the array of process components.

To find out how much memory to allocate, call C_GetFrequencyDomainProcessComponents3 passing NULL as the lpFrequencyDomainProcessComponents parameter and use the value returned in lpCount to determine the array length. The array must be of length *lpCount.

lpStatus (OUT)

Points to a variable in which the status result for the function call will be returned.