get_user_info

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 Header to Include
9 Reference

Description

Get a user binary storage by name as a Tree from the OriginObject

Syntax

bool get_user_info( OriginObject & obj, LPCSTR lpcszName, TreeNode & trUserInfo )

Parameters

obj: [input] Origin Object to get the storage
lpcszName: [input] the name of the storage
trUserInfo: [output] the tree to get the storage

Return

true if successfully get the storage tree,

false if obj is invalid or the storage tree not found

Examples

EX1

// Active window should be a worksheet
void get_user_info_ex1()
{
    Worksheet wks = Project.ActiveLayer();
    string strInfoName = "WksInfo";
    Tree trWksInfo;
    trWksInfo.AddTextNode("Worksheet has user info", "Notes");
    trWksInfo.AddNumericNode(0.5, "Number");
    bool bRet = set_user_info(wks, strInfoName, trWksInfo);
    
    Tree tr;
    bRet = get_user_info(wks, strInfoName, tr);
    out_tree(tr);
}