Difference between revisions of "Api.groups"
Chris Monson (Talk | contribs) (→getAttribute) |
Chris Monson (Talk | contribs) |
||
| Line 5: | Line 5: | ||
'''getAttribute(attribute As api.attributeTypes, groupPath As String) As Integer''' | '''getAttribute(attribute As api.attributeTypes, groupPath As String) As Integer''' | ||
| − | |||
Returns the value for a specified attribute on a specified group | Returns the value for a specified attribute on a specified group | ||
| − | |||
Returns -1 if the group can't be found | Returns -1 if the group can't be found | ||
| − | |||
| − | |||
| − | |||
| − | |||
==getChildCount== | ==getChildCount== | ||
| − | + | '''getChildCount(groupPath As String) As Integer''' | |
| − | + | Returns the number of children in a group | |
| + | Returns -1 if the group can't be found | ||
| + | |||
| + | ==getName== | ||
| + | '''getName(groupPath As String) As String''' | ||
| + | |||
| + | Returns the name of the requested group | ||
| + | Returns -1 if the group can't be found | ||
==setAttribute== | ==setAttribute== | ||
| − | + | '''setAttribute(attribute As api.attributeTypes, value As Integer, groupPath As String)''' | |
| − | + | ||
| + | Sets the value of an attribute on a specified group. | ||
| + | |||
==releaseAttribute== | ==releaseAttribute== | ||
| − | + | '''releaseAttribute(attribute As api.attributeTypes, groupPath As String)''' | |
| − | + | ||
| + | Releases the specified attribute on the specified group. | ||
==releaseGroup== | ==releaseGroup== | ||
| − | + | '''releaseGroup(attribute As api.attributeTypes, groupPath As String)''' | |
| − | + | ||
| + | Releases the all attributes on the specified group. | ||
Revision as of 18:39, 6 May 2013
Contents |
Methods
getAttribute
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
getChildCount(groupPath As String) As Integer
Returns the number of children in a group Returns -1 if the group can't be found
getName
getName(groupPath As String) As String
Returns the name of the requested group Returns -1 if the group can't be found
setAttribute
setAttribute(attribute As api.attributeTypes, value As Integer, groupPath As String)
Sets the value of an attribute on a specified group.
releaseAttribute
releaseAttribute(attribute As api.attributeTypes, groupPath As String)
Releases the specified attribute on the specified group.
releaseGroup
releaseGroup(attribute As api.attributeTypes, groupPath As String)
Releases the all attributes on the specified group.
