LookupPrivilegeValue function
Applies to: desktop apps only
The LookupPrivilegeValue function retrieves the locally unique identifier (LUID) used on a specified system to locally represent the specified privilege name.
Syntax
BOOL WINAPI LookupPrivilegeValue( __in_opt LPCTSTR lpSystemName, __in LPCTSTR lpName, __out PLUID lpLuid );
Parameters
- lpSystemName [in, optional]
-
A pointer to a null-terminated string that specifies the name of the system on which the privilege name is retrieved. If a null string is specified, the function attempts to find the privilege name on the local system.
- lpName [in]
-
A pointer to a null-terminated string that specifies the name of the privilege, as defined in the Winnt.h header file. For example, this parameter could specify the constant, SE_SECURITY_NAME, or its corresponding string, "SeSecurityPrivilege".
- lpLuid [out]
-
A pointer to a variable that receives the LUID by which the privilege is known on the system specified by the lpSystemName parameter.
Return value
If the function succeeds, the function returns nonzero.
If the function fails, it returns zero. To get extended error information, call GetLastError.
Remarks
The LookupPrivilegeValue function supports only the privileges specified in the Defined Privileges section of Winnt.h. For a list of values, see Privilege Constants.
Examples
For an example that uses this function, see Enabling and Disabling Privileges.
Requirements
|
Minimum supported client | Windows XP |
|---|---|
|
Minimum supported server | Windows Server 2003 |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names | LookupPrivilegeValueW (Unicode) and LookupPrivilegeValueA (ANSI) |
See also
Send comments about this topic to Microsoft
Build date: 3/7/2012
[DllImport("advapi32.dll", CharSet=CharSet.Auto, SetLastError=true)]
public static extern bool LookupPrivilegeValue([MarshalAs(UnmanagedType.LPTStr)] string lpSystemName, [MarshalAs(UnmanagedType.LPTStr)] string lpName, out LUID lpLuid);
<DllImport("advapi32.dll", CharSet:=CharSet.Auto, SetLastError:=True)> _
Public Shared Function LookupPrivilegeValue(<MarshalAs(UnmanagedType.LPTStr)> ByVal lpSystemName As String, <MarshalAs(UnmanagedType.LPTStr)> ByVal lpName As String, <Out> ByRef lpLuid As LUID) As Boolean
End Function
