2.2.4.42.2 storage::DeleteValue

DeleteValue

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

Description

Deletes a section variable

Syntax

BOOL DeleteValue( LPCSTR lpcszKey )

Parameters

lpcszKey: [input]name of the lpcszKey to be deleted

Return

Returns no zero success 0 otherwise

Examples

EX1

//run example code in Storage::SetSection before run this code to check the result.
void Storage_DeleteValue_ex1()
{
	Page pg = Project.Pages();
	if ( pg )
	{
	    string strStorage = "Test";
	    string strSection = "Params";
	    storage st;
	    st = pg.GetStorage(strStorage);
	    if ( st )
	    {
	    	Tree trParam;
	    	if ( st.GetSection(strSection, trParam) )
	    	{
	    		out_tree(trParam); //before delete a section variable
	    		st.DeleteValue("Params.AA.TITLE");
	    		if ( st.GetSection(strSection, trParam) )
	    			out_tree(trParam); //after delete a sectoin variable
	    	}
	    }
	}
}