updf_destroy_element

updf_destroy_element removes (destroys) a storage or stream in a storage.

ret = updf_destroy_element(stg, name)

Return Value

ret is TRUE (1) or an error object (see error_create).

Parameters

stg

stg is a storage object (see updf_create_file, updf_open_file, updf_create_storage).

name

name is the name of a Stream or Storage.

Comment

Example

def test_updf_destroy_element()
{
    ssFile = GetTempPath() + "test.updf";

    stg = updf_create_file(ssFile);

    f = updf_create_stream(stg, "test1");
    fwrite_int8(f, 123);
    updf_file_close(f);

    f = updf_create_stream(stg, "test2");
    fwrite_int8(f, 124);
    updf_file_close(f);

    updf_close_storage(stg);


    stg = updf_open_file(ssFile);
    updf_destroy_element(stg, "test1");
    updf_close_storage(stg);

    stg = updf_open_file(ssFile);
    f = updf_open_stream(stg, "test1");
    if (type(f) != "error") {
        error();
    }
    f = updf_open_stream(stg, "test2");
    if (type(f) == "error") {
        error();
    }
    updf_file_close(f);

    updf_close_storage(stg);
}

test_updf_destroy_element();

History

Version	Description
5.6.0	New

See also

Overview UPDF Files, updf_rename_element

_id-1126673