Column::SetEvenSampling

SetEvenSampling

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 header to Include

Description

Set the column sampling information.

Syntax

BOOL SetEvenSampling( double dX0, double dXInc, LPCSTR lpcszXUnits = NULL, LPCSTR lpcszXLongName = NULL, LPCSTR lpcszDispFormat = NULL, BOOL bUndo = FALSE, BOOL bUpdateDepCols = TRUE )

Parameters

dX0: [input] the starting X value.
dXInc: [input] the X increment value.
lpcszXUnits: [input] an optional LPCSTR, the X units name.
lpcszXLongName: [input] an optional LPCSTR, the X long name.
lpcszDispFormat: [input] and optional LPCSTR display format, LabTalk numeric format string, for example ".4" for 4 decimal places.
bUndo: [input] if bUndo is true, you can use Ctrl + Z to undo SetEvenSampling.
bUpdateDepCols: [input] TRUE to update dependent column. It can speed up if not to update dependent column.

Return

TRUE if succesfull, FALSE otherwise.

Examples

EX1

void Column_SetEvenSampling_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    
    if (!wks)
        return;
    
    Column col(wks, 0);
 
    double dX0 = 0.5;
    double dXInc = 0.5;
 
    string strXUnits = "Sampling Units";
    string strXLongName = "Long Name";
    if( col.SetEvenSampling(dX0, dXInc, strXUnits, strXLongName, NULL, true) )
    {
        printf("Sampling is succesfully set into Column %s .\n", col.GetName());
    }
}