Command
QisLib_GetStructureReferences Function: int QisLib_GetStructureReferences(const char* StructName, int Ref, int NestingL); Inputs: StructName: Name of the cell in question. Ref: Number of references to the specified cell to return. _QISSR_1(just one reference) or _QISSR_ALL(all references) NestingL: value >= 0 indicating the nesting level to traverse (cell reference hierarchy level).(_QISNL_ALL indicates all nesting levels). Return: success: 0 failure: one of the following values : Errors: -1: QisLib has not been initialized. -2: The callback function to handle vector data has not been set. -3: Internal error occurred while processing vector data. -4: Specified cell name is invalid. -5: Specified option for number of references is invalid. -6: Specified nesting level is invalid. -7: File open in progress, operation not permitted. Description: - This function can be used to get references to a cell within the current window area. - This function outputs cell references even if QisLib_SetReferenceVectorFormat is set to 'off'. However, the amount of detail will still vary depending on QisLib_SetReferenceVectorFormat and QisLib_SetVectorGrandParents settings. - This function outputs cell references and array cell references by calling the vector data handler set by the user program using QisLib_SetVectorDataCallback. Refer to QisLib_GetDataVector for the callback function details. - The 'NestingL' and 'Ref' parameters can be used to filter the data returned by this function. 'NestingL' instructs the function to find references only up to the specified cell reference hierarchy level. 'Ref' instructs the function to return either only the first reference or all references to the specified cell found in the current window. - To interrupt this function while it is returning data, the user program can call QisLib_Stop. This feature can only be used if QisLib_SetProcessEvents is on and for Unix/Linux, the program's application context was passed as a parameter to QisLib_InitLib.References: CQisSARef QisLib_SetReferenceVectorFormat QisLib_SetVectorGrandParents QisLib_SetVectorDataCallback QisLib_Stop QisLib_SetProcessEvents QisLib_InitLib |