Dataset::PutStringArray

PutStringArray

Description

Put (copy) the contents of a StringArray to a Text Dataset.

Syntax

BOOL PutStringArray( vector<string> & as, int nRow1 = 0 )

Parameters

as

[input] StringArray to copy

nRow1

[Input] starting row number of destination Dataset

Return

Returns TRUE on successful exit and FALSE on failure.

Examples

EX1

void Dataset_PutStringArray_ex1()
{
    // This test function assumes a worksheet with 3 columns 
    // first Column should have some number of text entries
    Worksheet wks=Project.ActiveLayer();
    if (wks)
    {          
        StringArray sa1, sa2;
        BOOL bRet;
        Dataset ds1(wks, 0);
        Dataset ds2(wks, 1);
        Dataset ds3(wks, 2);
        bRet = ds1.GetStringArray(sa1, 2, 5);
        bRet = ds1.GetStringArray(sa2);
        bRet = ds2.PutStringArray(sa1, 3);
        bRet = ds3.PutStringArray(sa2);
    }
}

Remark

This function is kept for compatibility reason only. It only works if you have correctly declare the Dataset to match internal column type. Better use the Column version of this function.

See Also

Column::PutStringArray, Column::GetStringArray, Dataset::GetStringArray

header to Include

origin.h