|
Command
QisLib_GetStructureChildren
Function:
int QisLib_GetStructureChildren(const char* StructName, char*** ChildListPtr);
Inputs:
StructName: Name of the cell in question.
ChildListPtr: Address of pointer of type char**. When the function returns
successfully, this pointer will point to a list of child cell names.
Return:
success: value > 0 indicating the number of children names returned in the list.
special: 0 indicating either no children found, or the specified cell does not exist.
failure: value < 0 indicating one of the following errors :
Errors:
-1: One or more input arguments is invalid (null).
-2: Internal memory error occurred while gathering cell information.
-3: File open in progress, operation not permitted.
Description:
- Gets a list of cell names referenced by the specified cell. Only direct children are
listed.
- It is the responsibility of the user to ensure that the memory allocated for the
list is freed by a call to QisLib_FreeStructureList().
- This function is not affected by QisLib_SetLoadEmptyRef setting.
Example:
char** List;
Ret = QisLib_GetStructureChildren("TOP",&List);
...
...
if(Ret > 0)
QisLib_FreeStructureList(List,Ret);
References:QisLib_FreeStructureList QisLib_SetLoadEmptyRef |