updf_rename_elementΒΆ

updf_rename_element changes the name of a stream or storage.

ret = updf_rename_element(stg, oldname, newname)

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).

oldname

oldname is the old name of a storage or stream.

newname

newname is the new name of a storage or stream.

Example

def test_updf_rename_element()
{
    ssPath = GetTempPath();

    stg = updf_create_file(ssPath + "test-rename.updf");
    f = updf_create_stream(stg, "test");
    fwrite_int8(f, 123);

    ret = updf_rename_element(stg, "test", "test-stream");
    if (type(ret) == "error") {
        error();
    }
    updf_file_close(f);

    ret = updf_rename_element(stg, "test-stream", "test-stream-2");
    if (type(ret) == "error") {
        error();
    }

    updf_close_storage(stg);

    stg = updf_open_file(ssPath + "test-rename.updf");
    f = updf_open_stream(stg, "test-stream-2");
    i8 = fread_int8(f, 1);
    if (i8 != 123) {
        error();
    }
    updf_file_close(f);
    updf_close_storage(stg);
}

test_updf_rename_element();

History

Version Description
5.6.0 New

id-1289254