updf_prop_delete

updf_prop_delete removes a property-object (key/value pair).

bool = updf_prop_delete(props, name)

Return Value

If the function succeeds, the return value is TRUE (1); otherwise it is FALSE (0).

Parameters

props

props.

name

name.

Example

def test_updf_prop_delete()
{
    ssFile = GetTempPath() + "test-prop-delete.updf";

    stg = updf_create_file(ssFile);

    props = updf_prop_open(stg);
    updf_prop_set_at(props, "a", updf_propval_new(1));
    updf_prop_set_at(props, "a1", updf_propval_new(2));
    updf_prop_set_at(props, "b", updf_propval_new(3));
    updf_prop_set_at(props, "abc", updf_propval_new(4));

    n = updf_prop_count(props);
    if (n != 4) {
        error();
    }

    updf_prop_delete(props, "abc");

    n = updf_prop_count(props);
    if (n != 3) {
        error();
    }

    updf_prop_close(props);

    updf_close_storage(stg);
}

test_updf_prop_delete();

History

Version	Description
5.6.0	New

See also

Overview UPDF Files, updf_prop_has_key

_id-1645322