ddCatOpen

ddCatOpen( 
b_ddId 
t_categoryName 
t_mode 
) 
=> b_objId / nil 

Description

Opens a category with the given name and uses the mode to get the object ID.

You can use ddCatGetLibCats to get the names of the categories in a library. With this list of names, you can use ddCatGetCatMembers to access the contents of each category. You can use subsequent calls to ddCatOpen and ddCatGetCatMembers to process hierarchical categories.

Like DFII design management, this interface does not let you create new categories if they already exist. This prevents recursive category specification within a library.

Arguments

b_ddId	The library ID or category ID (for hierarchical categories). If the object is a libId and the given name is " " or nil, the library’s list of categories can be accessed or modified.
t_categoryName	The name of the category.
t_mode	The modes "a", "w", or "r".

Values Returned

b_objId	The ID for the opened category.
nil	The category does not exist or cannot be opened in the specified mode.

Examples

Updates (or creates) a category and adds a cell name to it.

cat = ddCatOpen(libId "myCat" "a")
ddCatAddItem(cat "cell1" "cell")
ddCatSave(cat)
ddCatClose(cat)

Related Topics

ddGetObj

Return to top