Skip to content

rc-task.md

Latest commit

 

History

History
48 lines (40 loc) · 4.51 KB

rc-task.md

File metadata and controls

48 lines (40 loc) · 4.51 KB
title RC Task
description Learn how MSBuild uses the RC task to wrap the Microsoft Windows Resource Compiler tool, rc.exe, which compiles resources into a .res file.
ms.date 11/04/2016
ms.topic reference
f1_keywords
VC.Project.VCResourceCompilerTool.UndefineProcessorDefinitions
vc.task.rc
VC.Project.VCResourceCompilerTool.SuppressStartupBanner
VC.Project.VCResourceCompilerTool.NullTerminateStrings
dev_langs
C++
helpviewer_keywords
RC task (MSBuild (C++))
MSBuild (C++), RC task
author ghogen
ms.author ghogen
ms.subservice msbuild

RC task

[!INCLUDE C++-specific task]

Wraps the Microsoft Windows Resource Compiler tool, rc.exe. The RC task compiles resources, such as cursors, icons, bitmaps, dialog boxes, and fonts, into a resource (.res) file. For more information, see Resource Compiler.

Parameters

The following table describes the parameters of the RC task. Most task parameters, and a few sets of parameters, correspond to a command-line option.

Parameter Description
AdditionalIncludeDirectories Optional String[] parameter.

Adds a directory to the list of directories that are searched for include files.

For more information, see the /I option in Using RC (the RC command line).
AdditionalOptions Optional String parameter.

A list of command-line options; for example, /<option1> /<option2> /<option#>. Use this parameter to specify command-line options that are not represented by any other RC task parameter.

For more information, see the options in Using RC (the RC command line).
Culture Optional String parameter.

Specifies a locale ID that represents the culture used in the resources.

For more information, see the /l option in Using RC (the RC command line).
IgnoreStandardIncludePath Optional Boolean parameter.

If true, prevents the resource compiler from checking the INCLUDE environment variable when it searches for header files or resource files.

For more information, see the /x option in Using RC (the RC command line).
NullTerminateStrings Optional Boolean parameter.

If true, null-terminates all strings in the string table.

For more information, see the /n option in Using RC (the RC command line).
PreprocessorDefinitions Optional String[] parameter.

Define one or more preprocessor symbols for the resource compiler. Specify a list of macro symbols.

For more information, see the /d option in Using RC (the RC command line). Also see UndefinePreprocessorDefinitions in this table.
ResourceOutputFileName Optional String parameter.

Specifies the name of the resource file. Specify a resource file name.

For more information, see the /fo option in Using RC (the RC command line).
ShowProgress Optional Boolean parameter.

If true, displays messages that report on the progress of the compiler.

For more information, see the /v option in Using RC (the RC command line).
Source Required ITaskItem[] parameter.

Defines an array of MSBuild source file items that can be consumed and emitted by tasks.
SuppressStartupBanner Optional Boolean parameter.

If true, prevents the display of the copyright and version number message when the task starts.

For more information, type the /? command-line option and then see the /nologo option.
TrackerLogDirectory Optional String parameter.

Specifies the tracker log directory.
UndefinePreprocessorDefinitions Undefine a preprocessor symbol.

For more information, see the /u option in Using RC (the RC command line). Also see PreprocessorDefinitions in this table.

See also