LocalGroup

(Engine-Level Function)

Description	Returns an indication of whether the current Windows™ user is a member of the specified local group. LocalGroup interrogates only local groups, not domain groups.
Returns	Numeric
Usage	Script or steady state.
Function Groups	Security
Related to:
Format:	LocalGroup(Group)
Parameters

Group

Required. The group parameter, which is a value from 0 to 5. These values are defined in the following table:

Group	Local Group
0	Administrators
1	Backup Operators
2	Guests
3	Power Users
4	Replicator
5	Users

Comments

This function returns an indication of whether the current Windows™ user is a member of the specified local group. Its return values are outlined in the following table:

Return Value	Information
0	Not a member
1	Is a member
2	Not applicable

Invalid Parameter or internal error:

The user must sign out and sign in if a local group was changed for the change to be noticed by the LocalGroup function call. (This behavior is inherent to Windows and is not due to a VTScada feature or defect.)

Custom local groups (local groups that are not of type Administrators, Backup Operators, Guests, Power Users, Replicator or Users) cannot be interrogated by this function.