is_col_all_text

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

Description

check a worksheet column to see if it is really a text column

Syntax

int is_col_all_text( const Worksheet & wks, int nCol )

Parameters

wks: [input] worksheet to check
nCol: [input] column index (0 offset)

Return

1 if column is all text

0 if column has neumarical

-1 if nCol is not valid or wks not valid

Examples

EX1

//Make sure the active layer is a worksheet
void is_col_all_text_ex1()
{
    Worksheet wks = Project.ActiveLayer();
    int nRet = is_col_all_text(wks, 0);
    
    switch(nRet)
    {
    case 1:
        out_str("the column is all text");
        break;
    case 0:
        out_str("the column has numerical");
        break;
    case -1:
        out_str("the column or wks not valid");
        break;
    default:
        out_str("unknown error");
    }
}