read_folder


Description:

public bool read_folder (string folder_name, out StoreDBFolderRecord out_record) throws Error

Reads information about a folder named folder_name, previously stored by the write_folder.

The data in the out_record should be cleared by the clear , when no longer needed. The function returns success also when the folder information was not saved yet. It can be checked by the folder_id value, which is never zero for those existing tables.

Parameters:

this

a StoreDB

folder_name

name of the folder to read the record for

out_record

a StoreDBFolderRecord to read the values to

Returns:

whether succeeded with the read, but check the non-zero-ness of the folder_id member of the out_record to recognize whether it was found