C_GetDiffractionWaveComponents

Call C_GetDiffractionWaveComponents to get a list of wave components used in an OrcaWave model.

void C_GetDiffractionWaveComponents(

TOrcFxAPIHandle DiffractionHandle,

int *lpCount,

TDiffractionWaveComponent *lpWaveComponents,

int *lpStatus

);

Parameters

DiffractionHandle (IN)

The diffraction handle returned by C_CreateDiffraction.

lpCount (OUT)

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

lpWaveComponents (OUT)

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

To find out how much memory to allocate call C_GetDiffractionWaveComponents passing NULL as the lpWaveComponents parameter and use the value returned in lpCount to determine how much memory to allocate. 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.

See also

TDiffractionWaveComponent.