2.1.14.3.19 page_get_info_var_value

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

Description

Get the value of a variable in a Page's Info section

Syntax

bool page_get_info_var_value( Page & pg, LPCSTR lpcszVarName, string & strVal, LPCSTR lpcszStorageSection = NULL )

bool page_get_info_var_value( Page & pg, LPCSTR lpcszVarName, double & dVal, LPCSTR lpcszStorageSection = NULL )

Parameters

pg: [input] the page to get the value from
lpcszVarName: [input] pointer to the name of the variable
strVal: [output] the string to receive the value
lpcszStorageSection: [input] pointer to the name of the section. If NULL then the Variables section is used.

pg: [input] the page to get the value from
lpcszVarName: [input] pointer to the name of the variable
dVal: [output] the double to receive the value
lpcszStorageSection: [input] pointer to the name of the section. If NULL then the Variables section is used.

Return

If success then true else false

Examples

EX1

void Run_page_get_info_var_value_Ex1()
{
    string     strVal;    
    Page pg("Book1");
    bool bRet = page_get_info_var_value(pg,"var",strVal,"user.var");        
}

EX2

void Run_page_get_info_var_value_Ex2()
{
    double     dVal;    
    Page pg("Book1");
    bool bRet = page_get_info_var_value(pg,"var",dVal,"user.var");        
}