Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
5.4.1 - Português

Change language to:
English - Français - 日本語 - Русский

Please note that the recommended version of Scilab is 2024.0.0. This page might be outdated.
However, this page did not exist in the previous stable version.

Ajuda Scilab >> API Scilab > Low level functions > deleteNamedVariable

deleteNamedVariable

a C gateway function uses to delete a variable from name

Calling Sequence

int deleteNamedVariable(void* _pvCtx, const char* _pstName)

Arguments

_pvCtx

Scilab environment pointer, pass in "pvApiCtx" provided by api_scilab.h.

_pstName

Name of the variable.

Description

a C gateway function uses to delete a variable from name

Examples

Scilab test script

fileData = ['#include ""api_scilab.h""'
'#include ""MALLOC.h""'
''
'int sci_deleteNamedVariable(char *fname, unsigned long fname_len)'
'{'
'    SciErr sciErr;'
'    int iRet = 0;'
'    int* piAddr = NULL;'
'    char* pstVarName = NULL;'
''
'    CheckRhs(1,1);'
'    CheckLhs(1,1);'
''
'    sciErr = getVarAddressFromPosition(pvApiCtx, 1, &piAddr);'
'    if(sciErr.iErr)'
'    {'
'        printError(&sciErr, 0);'
'        return 1;'
'    }'
''
'    if(getAllocatedSingleString(pvApiCtx, piAddr, &pstVarName))'
'    {'
'        //error'
'        return 1;'
'    }'
''
'    if(isNamedVarExist(pvApiCtx, pstVarName))'
'    {'
'        iRet = deleteNamedVariable(pvApiCtx, pstVarName);'
'    }'
''
'    createScalarBoolean(pvApiCtx, Rhs + 1, iRet);'
'    AssignOutputVariable(pvApiCtx, 1) = Rhs + 1;'
'    return 0;'
'}'];

currentPath = pwd();
mkdir(TMPDIR + "/deleteNamedVariable");
cd(TMPDIR + "/deleteNamedVariable");
mputl(fileData, "deleteNamedVariable.c");

ilib_verbose(0);
files = ['deleteNamedVariable.c'];
ilib_build('libdeleteNamedVariable', ['deleteNamedVariable', 'sci_deleteNamedVariable'], files, []);
exec loader.sce;

function test()
    assert_checkequal(exists("a"), 1);
    assert_checkequal(a, 1);
    a = 2;
    assert_checkequal(a, 2);
    assert_checktrue(deleteNamedVariable("a"));
    assert_checkequal(exists("a"), 1);
    assert_checkequal(a, 1);
endfunction

a = 1;
test();
assert_checkequal(a, 1);
deleteNamedVariable("a");
assert_checkequal(exists("a"), 0);
Report an issue
<< Matrix Type (Scilab gateway) Low level functions Double reading (Scilab gateway) >>

Copyright (c) 2022-2023 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Tue Apr 02 17:37:07 CEST 2013