Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

CurrentUserHasPrivilege Method

NI TestStand™ 4.0 Help
April 2007

NI Part Number:
370052F-01

»View NI TestStand Product Info

Syntax

Engine.CurrentUserHasPrivilege ( privilegeName)

Return Value

Boolean

True if the current user has the privilege.

Purpose

Confirms whether the current user or any user group that the user is a member of has a specific privilege.

Remarks

Returns True when the privilege property is True, when the privilege property of any group that contains the privilege is True, or when privilege checking is disabled, StationOptions.EnableUserPrivilegeChecking is False. If privilege checking is disabled but StationOptions.RequireUserLogin is True, this function returns True only if there is a user currently logged on.

Parameters

privilegeName As String

[In] Specifies the name of the privilege to check. You can specify the name of any privilege property. You can specify the full privilege path in the user privileges property tree, for example, Debug.RunSelectedSteps, or you can specify the base privilege name, RunSelectedSteps. If you specify only the base privilege name and more than one instance of the base privilege name exists, then the method returns the value of the first base privilege it finds with that name. Refer to UserPrivileges for more information.


See Also

StationOptions.EnableUserPrivilegeChecking

StationOptions.RequireUserLogin

User

User.HasPrivilege

UserPrivileges


Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit