Revision as of 18:53, 6 May 2013

Information

A group path is a method for specifying a group in the group hierarchy. It is defined by use of a string.

An empty string ("") will specify the main group.

To specify a child of the main group you use that child's index number ex. "1"

To specify a child of a child, you use a comma, and the index of the next child you want to select ex. "1,3"

You can continue in this fashion throughout the group hierarchy. If you are looking at something nested deeply it may look like "1,3,2,1,4".

getAttribute(attribute As api.attributeTypes, groupPath As String) As Integer

Returns the value for a specified attribute on a specified group Returns -1 if the group can't be found

getChildCount(groupPath As String) As Integer

Returns the number of children in a group Returns -1 if the group can't be found

getName(groupPath As String) As String

Returns the name of the requested group Returns -1 if the group can't be found

releaseAttribute(attribute As api.attributeTypes, groupPath As String)

Releases the specified attribute on the specified group.

releaseGroup(attribute As api.attributeTypes, groupPath As String)

Releases the all attributes on the specified group.

setAttribute(attribute As api.attributeTypes, value As Integer, groupPath As String)

Sets the value of an attribute on a specified group.

@@ Line 1: / Line 1: @@
+=Information=
+==Group Paths==
+A group path is a method for specifying a group in the group hierarchy. It is defined by use of a string.
+An empty string ("") will specify the main group.
+To specify a child of the main group you use that child's index number ex. "1"
+To specify a child of a child, you use a comma, and the index of the next child you want to select ex. "1,3"
+You can continue in this fashion throughout the group hierarchy. If you are looking at something nested deeply it may look like "1,3,2,1,4".
 =Methods=