Variables in Preference Items

Variables in Preference Items

Applies To: Windows Server 2008 R2

Preference extensions support Windows environment variables and generate a number of additional process environment variables. Any variable may be used in a configuration parameter value. Each Help document states whether variables are supported in a specific field.

Note
By using Registry Match Targeting targeting items, you can define variables at client run-time, and have these control behavior by using the Environment Variable Targeting targeting items or as values in a preference item setting.

Windows environment variables

The Windows environment is a list of variables saved as name/value pairs. To see the current list of variables, type SET at the command prompt. Each process, including the desktop, has a list of variables unique to the process. When one process starts another, normally a copy of the environment of the starting process is passed to the started process. Typically, environment variable names are enclosed between two percent signs (for example, %ProgramFiles%). Windows resolves the environment variable when an application requests the value associated to the name.

Preference process variables

Preference extensions implement the process variables that are listed here.

Note
Variables are not case-sensitive.

%AppDataDir%	The current user's Application Data directory.
%BinaryComputerSid%	The SID of the computer in hexadecimal format.
%BinaryUserSid%	The SID of the current user in hexadecimal format.
%CommonAppdataDir%	The "all users" Application Data directory.
%CommonDesktopDir%	The "all users" Desktop directory.
%CommonFavoritesDir%	The "all users" Explorer Favorites directory.
%CommonProgramsDir%	The "all users" Programs directory.
%CommonStartMenuDir%	The "all users" Start Menu directory.
%CommonStartUpDir%	The "all users" Startup directory.
%ComputerName%	The NetBIOS name of the computer.
%CurrentProcessId%	The numeric identity of the main client process.
%CurrentThreadId%	The numeric identity of the main client thread.
%DateTime%	The current time (UTC).
%DateTimeEx%	The current time (UTC) with milliseconds.
%DesktopDir%	The current user's desktop directory.
%DomainName%	The domain name or workgroup of the computer.
%FavoritesDir%	The current user's Explorer Favorites directory.
%LastError%	The last error code encountered during configuration.
%LastErrorText%	The last error code text description.
%LdapComputerSid%	The SID of the computer in LDAP escaped binary format.
%LdapUserSid%	The SID of the current user in LDAP escaped binary format.
%LocalTime%	The current local time.
%LocalTimeEx%	The current local time with milliseconds.
%LogonDomain%	The domain of the current user.
%LogonServer%	The domain controller that authenticated the current user.
%LogonUser%	The user name of the current user.
%LogonUserSid%	The SID of the current user.
%MacAddress%	The first detected MAC address on the computer.
%NetPlacesDir%	The current user's My Network Places directory.
%OsVersion%	The operating system: Windows Server® 2008 R2, Windows® 7, Windows Server® 2008, Windows Vista®, Windows Server 2003, Windows XP, or Unknown.
%ProgramFilesDir%	The Windows Program Files directory.
%ProgramsDir%	The current user's Programs directory.
%RecentDocumentsDir%	The current user's Recent Documents directory.
%ResultCode%	The client's exit code.
%ResultText%	The client's exit code text description.
%ReversedComputerSid%	The SID of the computer in reversed byte order hexadecimal format.
%ReversedUserSid%	The SID of the current user in reversed byte order hexadecimal format.
%SendToDir%	The current user's Send to directory.
%StartMenuDir%	The current user's Start Menu directory.
%StartUpDir%	The current user's Startup directory.
%SystemDir%	The Windows system directory.
%SystemDrive%	The name of the drive from which the operating system is running.
%TempDir%	The current user's Temp directory as determined by Windows API.
%TimeStamp%	The time stamp of the configurations being implemented.
%TraceFile%	The path/name of the trace file.
%WindowsDir%	The Windows directory.

Preference extensions provide a list of variables from which you can choose to insert into text boxes. You can open the dialog box from any text box that is:

Not disabled.
Not read-only.
Not restricted to a numeric value.

To enter a variable

Open the Group Policy Management Console. Right-click the Group Policy object (GPO) that contains the preference item that you want to configure, and then click Edit.

Position the cursor in the desired box.

To enter a preference process variable, press F3, select a variable from the list, and then click Select to insert the variable in the box.

To enter an existing Windows environment variable, type the variable in the box.

Note
You can prevent the resolution of a variable before it is applied to client computers (so that the variable instead of the resolved value appears in the preference setting on client computers). To do this for a preference process variable, clear the Resolve Variable check box. This inserts <> between the %% delimiters and the variable name (for example, %<ProgramFiles>%). Preference extensions remove < > characters from the text and leave the unresolved variable. You can also use this syntax with a Windows environment variable.

Note

You can prevent the resolution of a variable before it is applied to client computers (so that the variable instead of the resolved value appears in the preference setting on client computers). To do this for a preference process variable, clear the Resolve Variable check box. This inserts <> between the %% delimiters and the variable name (for example, %<ProgramFiles>%). Preference extensions remove < > characters from the text and leave the unresolved variable. You can also use this syntax with a Windows environment variable.

Additional references

Configure, Target, and Comment Preference Items