Export (0) Print
Expand All

Visual C++ Extensibility Object Model Shared Methods and Properties

Visual Studio .NET 2003

The following methods and properties are implemented by more than one object in the Visual C++ Extensibility Object Model.

Method Description
AbortTransaction Method Aborts the current transaction.
AddActiveXReference Method Adds an ActiveX reference to the project.
AddAssemblyReference Method Adds an assembly reference to the selected project.
AddAt Method Adds the type library or control to the collection at the specified position.
AddEvent Method Adds an event to the parent object.
AddFile Method Adds a file to the current project or folder.
AddFilter Method Adds a folder to the current project or folder.
AddItem Method Adds the specified control or type library to the collection.
AddMap Method (VCCodeClass) Adds a map entry to the parent object.
AddMap Method Adds a map to the parent object.
AddParameter Method Creates a new parameter code construct and inserts the code in the correct location.
AddProjectReference Method Adds a project reference to the project.
AddTypedef Method Adds a Typedef statement to the parent object.
AddUnion Method Adds a union statement to the parent object.
CanAddActiveXReference Method Returns whether it is okay to add the given ActiveX reference.
CanAddAssemblyReference Method Returns whether it is okay to add the given assembly reference.
CanAddFile Method Returns True if the specified file can be added to the current project or filter.
CanAddFilter Method Returns True if the specified filter can be added as a top-level filter or as a subfilter to the current filter.
CanAddProjectReference Method Returns whether it is okay to add the given project reference.
CanMove Method Returns True if a file, filter, project, or project item can be moved to the specified location.
CodeElementFromFullName Method Returns a collection of the specified code elements for the parent object.
CommitTransaction Method Commits the current transaction for the parent object.
Compile Method Compiles the selected file or reference.
Evaluate Method Evaluates the value of a Project Model or environment macro. See Macros for Build Commands and Properties for more information on these macros.
Find Method Returns the specified code element of the parent object.
IsSelf Method Determines if the specified code element is the same as the parent code element.
item Method Returns the interface for the specified item in the collection.
MatchName Method Specifies a name to match when indexing into the collection.
Move Method Moves a file or folder into the top level of the project or a new folder.
RemoveFile Method Removes a file from the current project or folder.
RemoveFilter Method Removes a folder from the current project and any files or other folders in the folder.
RemoveReference Method Removes the specified reference from the project or references collection.
SetSite Method Sets the object's site to the IUnknown of the service provider object.
StartTransaction Method Begins a transaction.
Synchronize Method Synchronizes all code model objects in the solution with edits made to source files.
ValidateFile Method Validates that the specified file name is valid.
ValidateMember Method Validates that the proposed name is a valid C++ name for the kind given in the context of the parent object.
Property Description
AdditionalDependencies Property Specifies additional, configuration-specific items to add to the link line, such as comdlg32.lib or kernel32.lib.
AdditionalIncludeDirectories Property Specifies one or more directories to add to the include path.
AdditionalLibraryDirectories Property Specifies one or more additional paths (configuration specific) to search for libraries.
AdditionalOptions Property Specifies options to add to the end of the command line immediately before the file name(s). An example is if an option is not supported in the object model.
AppliedStyleSheets Property Displays or changes the inherited style sheets. In the case of Visual C++ .NET, it is not possible to add your own style sheets to a project.
ATLMinimizesCRunTimeLibraryUsage Property Causes ATL to link to the C run-time libraries statically to minimize dependencies; requires that useOfATL Property be set.
BodyText Property Gets or sets the body text of the parent object.
BuildBrowserInformation Property Builds the browser (.bsc) information for this configuration.
BuildNumber Property The build number of the referenced assembly.
CharacterSet Property Tells the compiler to use the specified character set.
Classes Property Returns a collection of classes for the parent object.
CommandLine Property Specifies a command line for the build event tool to run.
CopyLocal Property Sets or returns whether to automatically copy the reference to the target directory.
Count Property Returns number of items in the collection.
Culture Property For the VCResourceCompilerTool object, returns the culture (such as U.S. English or Mexican Spanish) used in the resources. Exposes the functionality of the Resource Compiler's /l option.

For all other objects, returns the culture for the selected reference.

DeclarationText Property Gets or sets the declaration of the parent object.
DelaySigning Property Sets or returns whether to force strong name delay signing. Exposes the functionality of the /DELAYSIGN option.
Delegates Property Returns a collection of delegates for the parent object.
DeleteExtensionsOnClean Property Specifies which files in the intermediate directory to delete on clean or rebuild.
DispID Property Returns or sets the variable or function dispatch ID.
DisplayName Property Returns the full name of the parent object.
EndPointOf Property Returns the end point of the parent object.
Enums Property Returns a collection of enumerations for the parent object.
Events Property Returns a collection of events for the parent object.
ExcludedFromBuild Property Specifies whether this item is excluded from the build.
Files Property Returns the collection of files on the object.
FileTools Property Lists the available tools that operate on files.
Filters Property Returns the collection of filters (or folders) on the object.
ForceSymbolReferences Property Forces the linker or librarian to include a reference to this symbol. Exposes the functionality of the linker's /INCLUDE option or the librarian's /INCLUDE option.
FullIncludePath Property Returns a list of all directories included in the build; a concatenation of directories specified with /I and the directories specified in the VC++ Directories dialog box.
FullReferencesPath Property Returns the path to search for references, including all inherited parts of the path.
FunctionName Property Specifies the name of the function.
Functions Property Returns a collection of functions for the parent object.
HelpString Property Returns the variable or function Help string.
Identity Property The identity of the referenced assembly.
IDLImports Property Returns the collection of Import statements from the .idl file of the parent object.
IDLLibraries Property Returns the collection of Library elements on the object.
IgnoreAllDefaultLibraries Property Tells the linker or librarian to ignore all default libraries. Exposes the functionality of the /NODEFAULTLIB linker option and the /NODEFAULTLIB LIB option.
IgnoreDefaultLibraryNames Property Specifies one or more default libraries to ignore. Exposes the functionality of the /NODEFAULTLIB linker option and the /NODEFAULTLIB LIB option.
IgnoreStandardIncludePath Property Ignore standard include path. Exposes the functionality of the compiler's /X option, the MIDL compiler's /no_def_idir option, and the Resource Compiler's /X option.
ImportLibrary Property Specifies which import library to generate or reports which import library will be generated by the configuration. Exposes the functionality of the /IMPLIB linker option.
Imports Property Returns the collection of #import statements for the parent object.
Includes Property Returns the collection of #include statements for the parent object.
Index Property Returns the position of an attribute in the attribute block or a parameter in a parameter list.
Interfaces Property Returns the collection of interfaces for the parent object.
IntermediateDirectory Property Specifies a relative path to the intermediate file directory; can include environment variables.
IsCaseSensitive Property Determines if a code element is case-sensitive.
IsInjected Property Determines if a code element has been injected by an attribute or macro expansion.
IsManaged Property Determines if the parent object is managed.
IsReadOnly Property Determines if the file containing the parent object is read-only.
IsSealed Property Determines if the __sealed keyword is applied to the parent object.
IsTemplate Property Determines if the parent object is a template.
IsValue Property Determines if the __value keyword is applied to the parent object.
IsVirtual Property Determines if the parent object is virtual.
IsZombie Property Determines if the parent object exists.
ItemName Property Returns the name of the current item in the collection.
Items Property Returns the collection of files and top-level folders in a project or the collection of files and folders in a folder.
Label Property Returns the display name of the referenced assembly.
Location Property (Visual C++ Wizard Model) Returns a string containing the location of the specified item.
Location Property Returns the location of the parent object declaration.
Macros Property Returns the collection of macros (#define statements) for the parent object.
MajorVersion Property (VCProjectEngine) Returns the major version of the referenced assembly.
ManagedExtensions Property Specifies that this configuration uses Managed Extensions for C++. Exposes the functionality of the C++ compiler's /clr option.
Maps Property Returns the collection of maps for the parent object.
MinorVersion Property (VCProjectEngine) Returns the minor version of the referenced assembly.
ModuleDefinitionFile Property Uses the specified module definition file during executable creation. Exposes the functionality of the linker's /DEF option and the librarian's /DEF option.
Namespace Property (VCProjectEngine) Sets or returns an object defining the parent namespace.
Namespaces Property Returns the collection of namespaces for the parent object.
Object Property Provides a reference between the Visual Studio .NET object model and the Visual C++ .NET object model.
Output Property Specifies the output file name.
OutputDirectory Property Specifies directory to place output; by default, uses the project directory.
OutputFile Property Overrides the default output file name; the default is based on the first .lib or .obj name on the command line. Exposes the functionality of the linker's /OUT option, the librarian's /OUT option, and the BSCMake tool's /OUT option.
OutputMessageType Property Sets or returns the level of verbosity of output messages to generate during the build.
OutputName Property Specifies the name of the generated wrapper DLL.
OutputUpToDate Property Specifies whether the output of the specified file is up-to-date.
Picture Property Returns a picture automation object representing the parent object.
Platform Property Specifies the platform this configuration is being built for.
PreprocessorDefinitions Property Specifies one or more preprocessor defines. Exposes the functionality of the compiler's /D option, the MIDL compiler's /D option, and the Resource Compiler's /r option.
Program Property Specifies the name of the program.
project Property Points to the project this configuration or file is associated with.
ProjectConfiguration Property The project configuration associated with the selected file configuration.
Properties Property Returns the collection of properties for the parent object.
PublicKeyFile Property Specifies the file containing the strong name public key. Exposes the functionality of the /publickey option.
PublicKeyToken Property Returns the public key token for the referenced assembly.
Reference Property Displays the reference associated with this configuration.
ReferenceConfigurations Property Returns the collection of configurations for this referenced assembly.
References Property Returns the collection of references for the selected project.
ReferencesPath Property Sets or returns the path to search for references.
ReferenceTools Property Returns a list of the available tools that operate on references.
RegisterOutput Property Reports whether the configuration will register the primary output of this build.
RevisionNumber Property Returns the revision number of the selected reference.
ShowProgress Property Enables detailed display about linker progress. Exposes the functionality of the linker's /VERBOSE option and the Resource Compiler's /v option.
StartPointOf Property Returns the start point of the parent object.
StrongName Property (VCProjectEngine) [Variant 1] Returns whether or not the selected reference has a strong name.
StrongName Property (VCProjectEngine) [Variant 2] Sets or returns the file or container from which to obtain strong name information.
StrongNameType Property Specifies how to work with strong names.
StructMemberAlignment Property Specifies 1, 2, 4, 8, or 16-byte boundaries for struct member alignment. Exposes the functionality of the C++ compiler's /Zp option, and the MIDL compiler's /Zp option.
Structs Property Returns the collection of structure elements for the parent object.
StyleSheets Property Returns the collection of style sheets applied to the collection.
SuppressStartupBanner Property Suppress the display of the startup banner and information messages. Exposes the functionality of the linker's /NOLOGO option, the librarian's /NOLOGO option, the compiler's /nologo option, the BSCMake tool's /OUT option, and the MIDL compiler's /nologo option.
Templatizations Property Returns a collection of template parameters for the parent object.
Tool Property (VCProjectEngine) Specifies the tool that will build the file.
ToolKind Property Returns the name of the kind of tool this is.
ToolName Property Specifies the name of the tool.
ToolPath Property Specifies the command-line name of the tool.
Tools Property Lists the available tools for the platform.
Typedefs Property Returns the collection of Typedef elements for the parent object.
TypeString Property (Visual C++ Wizard Model) Gets the type of the function or parameter using a string representation of the type.
TypeString Property Gets or sets the type of the parent object using a string representation of the type.
UndefinePreprocessorDefinitions Property Specifies one or more preprocessor undefines. Exposes the functionality of the C++ compiler's /U option and the MIDL compiler's /U option.
Unions Property Returns the collection of Union elements for the parent object.
useOfATL Property Specifies how ATL is used by the configuration.
useOfMfc Property Specifies how MFC is used by the configuration.
Usings Property Returns the collection of #using elements for the parent object.
Variables Property Returns the collection of variables for the parent object.
VariantType Property Returns the parameter's or variable's variant type.
VCProjectEngine Property Returns a pointer to the project engine.
Version Property (Visual C++ Wizard Model) Returns the version of the type library or control.
Version Property (Visual C++ Wizard Model) Returns the version of the type library or control.
Version Property (VCProjectEngine) [Variant 1] Use this value as the version number in the image header. Exposes the functionality of the linker's /VERSION option.
VTSType Property Returns the VTS type of the parameter or variable.
WarnAsError Property Enables the compiler to treat all warnings as errors. Exposes the functionality of the C++ compiler's /WX option and the MIDL compiler's /WX option.
WarningLevel Property Selects how strict you want the compiler to be about checking for potentially suspect constructs. Exposes the functionality of the C++ compiler's /W option and the MIDL compiler's /W option.
WholeProgramOptimization Property Enables cross-module optimizations by delaying code generation to link time. Exposes the functionality of the compiler's /GL option.

See Also

Visual C++ Extensibility Object Model

Show:
© 2014 Microsoft