Description (Standard 8 Module Reference)
7/8/2014
Review the applicable Embedded Core modules and any examples for the Description setting in Windows Embedded 8 Standard (Standard 8).
This setting contains a string that specifies a description. Depending on what module you apply this setting to, the string can be in the format of the description text itself or a path to the DLL that contains the description text.
Modules
The following table shows the modules that you can apply this setting to. In Image Configuration Editor (ICE), you can follow the corresponding path to set this setting for a module.
Module |
Path |
Setting Description |
|---|---|---|
Features/Diagnostics, Feedback and Maintenance/Troubleshooting/Description |
A path to the DLL that contains the description text to display for the Online Support icon in Control Panel. The string is in the format @dllname,-resourceID, where dllname is the full path to the resource DLL. |
|
Products/Embedded Core/Deployment/RunAsynchronous/RunAsynchronousCommand/Description |
A string with a maximum length of 259 characters that describes the asynchronous command to execute authentication when starting a device in Audit mode during deployment. Do not create an empty value for this setting. |
|
Products/Embedded Core/Deployment/RunSynchronous/RunSynchronousCommand/Description |
A string with a maximum length of 259 characters that describes the synchronous command to execute authentication when starting a device in Audit mode during deployment. Do not create an empty value for this setting. |
|
Products/Embedded Core/Setup/RunAsynchronous/RunAsynchronousCommand/Description |
A string that specifies the command to run asynchronously (as specified by Path) during the Windows Preinstallation Environment (Windows PE) 4.0 configuration pass. Do not create an empty value for this setting. These RunAsynchronous commands run in the system context. |
|
Products/Embedded Core/Setup/RunSynchronous/RunSynchronousCommand/Description |
This setting contains a string that describes the command to run synchronously (as specified by Path). All RunSynchronous commands run in the system context. |
|
Products/Embedded Core/Shell-Setup/FirstLogonCommands/SynchronousCommand/Description |
A string with a maximum length of 256 characters that describes the synchronous command to run at logon. |
|
Products/Embedded Core/Shell-Setup/LogonCommands/AsynchronousCommand/Description |
A string with a maximum length of 256 characters that describes the asynchronous command to run at logon. |
|
Products/Embedded Core/Shell-Setup/UserAccounts/LocalAccounts/LocalAccount/Description |
A string with a maximum length of 256 characters that specifies a description of a local account to be created during installation. This setting can be empty. |
|
Products/Embedded Core/shwebsvc/Description |
A string wittthhh a maximum length of 80 characters that specifies the description of the online printing company to display in the Online Print Wizard. |
XML Example
The following XML examples show how to configure the Description setting.
Diagnostics Troubleshooting
The following XML example shows how to set Description in Troubleshooting to configure the Online Support icon to point to the Fabrikam Troubleshooting application.
<Title>@%SystemRoot%\System32\DiagCpl.dll,-82</Title>
<Description>@%SystemRoot%\System32\DiagCpl.dll,-83</Description>
<Icon>@%SystemRoot%\System32\imageres.dll,-179</Icon>
<Link>http://www.fabrikam.com/support</Link>
First Logon Commands
The following XML example shows how to specify a command to run after first logon.
<FirstLogonCommands>
<SynchronousCommand wcm:action="add">
<CommandLine>c:\synccommands\command1.exe</CommandLine>
<Description>Description_of_command1</Description
<Order>1</Order>
</SynchronousCommand>
</FirstLogonCommands>
For more examples of first logon commands, see FirstLogonCommands XML Example.
LogonCommands
The following XML example shows examples of how to set two logon commands. The RequiresUserInput setting has no effect for either of the commands.
<LogonCommands>
<AsynchronousCommand wcm:action="add">
<CommandLine>c:asynccommands\command1.exe</CommandLine>
<Description>Description_of_command1</Description>
<Order>1</Order>
<RequiresUserInput>true</RequiresUserInput>
</AsynchronousCommand>
<AsynchronousCommand wcm:action="add">
<CommandLine>c:asynccommands\command2.exe</CommandLine>
<Description>Description_of_command2</Description>
<Order>2</Order>
<RequiresUserInput>false</RequiresUserInput>
</AsynchronousCommand>
</LogonCommands>
User Interface
The following XML example shows how to set Description in Shell Foundation to configure the text to display in the Online Print Wizard.
<Description>Get photos printed by Lucerne and delivered to your home.</Description>
Local Account
The following XML example shows how to set UserAccounts.
<UserAccounts>
<LocalAccounts>
<LocalAccount wcm:action="add">
<Password>
<Value>cAB3AFAAYQBzAHMAdwBvAHIAZAA</Value>
</Password>
<Description>Test account</Description>
<DisplayName>Admin/Power User Account</DisplayName>
<Group>Administrators;Power Users</Group>
<Name>Test1</Name>
</LocalAccount>
</LocalAccounts>
</UserAccounts>
Deployment Run Synchronous Command
The following XML example shows how to describe the synchronous command to execute authentication when starting a device in Audit mode during deployment.
<RunSynchronous>
<RunSynchronousCommand wcm:action="add">
<Credentials>
<Domain>MyDomain</Domain>
<Password>MyPassword</Password>
<Username>MyUsername</Username>
</Credentials>
<Description>MySynchCommand1</Description>
<Order>1</Order>
<Path>\\network\server\share\filename</Path>
<WillReboot>OnRequest</WillReboot>
</RunSynchronousCommand>
</RunSynchronous>
For another example, see Deployment with Synchronous Command XML Example.
Deployment Run Asynchronous Command
The following XML example shows how to describe the asynchronous command to execute authentication when starting a device in Audit mode during deployment.
<RunAsynchronous>
<RunAsynchronousCommand wcm:action="add">
<Credentials>
<Domain>MyDomain</Domain>
<Password>MyPassword</Password>
<Username>MyUsername</Username>
</Credentials>
<Description>AsynchCommand1</Description>
<Order>1</Order>
<Path>\\network\server\share\filename</Path>
</RunAsynchronousCommand>
</RunAsynchronous>
For another example, see Deployment with Asynchronous Command XML Example.
Setup Run Synchronous Command
The following XML example shows how to configure commands to run synchronously during the Windows Preinstallation Environment (Windows PE) 4.0 configuration pass.
<RunSynchronous>
<!-- First synchronous command to execute -->
<RunSynchronousCommand>
<Order>1</Order>
<Path>\\MyNetworkShare\MyApplication.exe</Path>
<Description>DescriptionOfMyApplication</Description>
<Credentials>
<Domain>FabrikamDomain</Domain>
<UserName>MyUserName</UserName>
<Password>MyPassword</Password>
</Credentials>
</RunSynchronousCommand>
<!-- Second synchronous command to execute -->
<RunSynchronousCommand>
<Order>2</Order>
<Path>C:\AnotherApplication.exe</Path>
<Description>DescriptionOfMyApplication</Description>
</RunSynchronousCommand>
</RunSynchronous>
Setup Run Asynchronous Command
The following XML example shows how to configure commands to run asynchronously during the Windows Preinstallation Environment (Windows PE) 4.0 configuration pass.
<RunAsynchronous>
<RunAsynchronousCommand>
<Order>1</Order>
<Path>\\MyNetworkShare\MyApplication.exe</Path>
<Description>DescriptionOfMyApplication</Description>
<Credentials>
<Domain>FabrikamDomain</Domain>
<UserName>MyUserName</UserName>
<Password>MyPassword</Password>
</Credentials>
</RunAsynchronousCommand>
<RunAsynchronousCommand>
<Order>2</Order>
<Path>C:\AnotherApplication.exe</Path>
<Description>DescriptionOfMyApplication</Description>
</RunAsynchronousCommand>
</RunAsynchronous>