Layer::LT_get_str

LT_get_str

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

Description

Get LabTalk string with a specific layer as the active layer.

Syntax

BOOL LT_get_str( LPCSTR lpcszLabTalkString, char * pBuffer, int nBufferSize )

Parameters

lpcszLabTalkString: [input] LabTalk global string, or any other LabTalk string expression
pBuffer: [output] character buffer to receive the string
nBufferSize: [input] size of the buffer including the terminating zero

Return

Return TRUE if success, return FALSE if string variable is not correctly specified or string is too long.

Examples

EX1

//Output the worksheet's name.
void    Layer_LT_get_str_ex1()
{
        char    szBuffer[200];
        Worksheet wks;
        wks.Create("Origin");
        //Get the layer's name.
        wks.LT_get_str("layer.name$", szBuffer, 200);
        out_str(szBuffer);
}

Remark

lstrcpyn is used inside Origin to copy LabTalk string into the buffer supplied, so that if the buffer is too small, the result string will have one less character than specified to leave room for the terminating character.

The Layer Object is only temporarily set as the active layer. The Layer that was active before the code executes is restored as active upon return.