Project

General

Profile

$group » History » Revision 3

Revision 2 (Per Amundsen, 08/11/2015 01:13 PM) → Revision 3/7 (Per Amundsen, 08/11/2015 01:13 PM)

_Added in 1.9.0_ 

 *$group(#|N)* 

 Returns the name or status of a [[Scripting_Groups|scripting group]] [[Scripting_Groups|#group]] in a script. 

 *Parameters* 

 #|N - Group name or if N = 0, number of groups, otherwise the Nth group. 

 *Properties* 

 .status - Returns on or off. 
 .fname - Returns the script filename in which the group exists. 
 .name - Returns name of the group. 

 *Examples* 

 <pre> 
 ; Create a group 
 #example on 
 alias Example { 
   echo -ag Group works 
 } 
 #example end 

 ; Print number of groups. 
 //echo -ag $group(0) 

 ; Print the '#example' group status. 
 //echo -ag #example1 is $group(#example1).status 

 ; Disable the '#example' group 
 /disable #example 

 ; Print the '#example' group status again. 
 //echo -ag #example1 is $group(#example1).status 
 </pre>