Worksheet::GetScript

GetScript

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

Description

Worksheet script getting

Syntax

BOOL GetScript( string & strScript, DWORD & dwCntrl, string & strRangeCheckChange )

Parameters

strScript: [output] labtalk script in worksheet
dwCntrl: [output] bits to control the usage of the script, see WKSC_CNTL_IMPORT etc in oc_const.h
strRangeCheckChange: [output] optional range string that will trigger this script to run when data inside the range is modified

Return

TRUE for success, otherwise return false.

Examples

EX1

//labtalk script in worksheet. 
void Worksheet_GetScript_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    
    string strScript, strRange;
    DWORD dwCntrl;
    if(wks.GetScript(strScript, dwCntrl, strRange))
    {
        out_str(strRange);
        out_int("dwCntrl = ", dwCntrl);
        out_str(strScript);
    }
}