DriveWorks Pro 15: SppGetVariableCategories [send feedback...]

SppGetVariableCategories

Returns an array of project variable categories.

Syntax

SppGetVariableCategories([Include sub categories])

Where:

Include sub categories is True to include categories that are sub categories of a parent, FALSE to omit.

Examples

Consider the category structure in the image below:

The following rules would return the results as shown in the results column:

RuleMeaningResult
SppGetVariableCategories(True)Will return an array of all variable categories including sub categories.{"Category Name","Category Path","Variable Count";"No Category","",1;"Category A","Category A",2;"Sub Category AA","Category A\Sub Category AA",3;"Sub Category AB","Category A\Sub Category AB",3;"Category B","Category B",2;"Sub Category BA","Category B\Sub Category BA",3;"Sub Category BB","Category B\Sub Category BB",3}
SppGetVariableCategories(False)Will return an array of all top level variable categories only.{"Category Name","Category Path","Variable Count";"No Category","",1;"Category A","Category A",2;"Category B","Category B",2}

Results as a table

The results for the first example above will appear as below when presented in tabular format:

Category NameCategory PathVariable Count
No Category1
Category ACategory A2
Category BCategory B2

The results for the second example above will appear as below when presented in tabular format:

Category NameCategory PathVariable Count
No Category1
Category ACategory A2
Sub Category AACategory A\Sub Category AA3
Sub Category ABCategory A\Sub Category AB3
Category BCategory B2
Sub Category BACategory B\Sub Category BA3
Sub Category BBCategory B\Sub Category BB3

Table of Contents