C_DeleteDataRow

Call C_DeleteDataRow to delete a row from a table of indexed data.

An example of indexed data is the section data (line type, section length, target segment length etc.) for an OrcaFlex line. Calling C_DeleteDataRow for section data names (e.g. "LineType", "Length", "TargetSegmentLength") results in the deletion of a section.

void C_DeleteDataRow(

TOrcFxAPIHandle ObjectHandle,

LPCTSTR lpDataName,

int Index,

int *lpStatus

);

Parameters

ObjectHandle

The handle of the object which owns the data.

lpDataName (IN)

Points to a null-terminated string containing the name of the data item. This is the same name as used in OrcaFlex script files. To find what the name is for a particular data item you should select the data item on the OrcaFlex data form and press F7. For more information see the batch processing section of the OrcaFlex documentation.

Index (IN)

The index of the row to be deleted.

lpStatus (OUT)

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

Unicode and ANSI

The Unicode function name is C_DeleteDataRowW and the ANSI function name is C_DeleteDataRowA.