IBuilderWizardManager.MapBuilderCATIDToCLSID Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the CLSID of a specific builder given a component category ID (CATID).

public:
 int MapBuilderCATIDToCLSID(Guid % rguidBuilder, System::UInt32 dwPromptOpt, IntPtr hwndPromptOwner, [Runtime::InteropServices::Out] Guid % pclsidBuilder);

public int MapBuilderCATIDToCLSID (ref Guid rguidBuilder, uint dwPromptOpt, IntPtr hwndPromptOwner, out Guid pclsidBuilder);

abstract member MapBuilderCATIDToCLSID : Guid * uint32 * nativeint * Guid -> int

Public Function MapBuilderCATIDToCLSID (ByRef rguidBuilder As Guid, dwPromptOpt As UInteger, hwndPromptOwner As IntPtr, ByRef pclsidBuilder As Guid) As Integer

Parameters

rguidBuilder: Guid

[in] The CATID of a builder.If the GUID is a CLSID of a specific builder and IBuilderWizardManager supports this builder, this method returns S_OK and sets pclsidBuilder to rguidBuilder.

dwPromptOpt: UInt32

[in] Bit flags controlling whether there is a user prompt to choose the builder. Values are taken from the BLDPROMPTOPT enumeration.

hwndPromptOwner: IntPtr
nativeint

[in] Owner HWND for all dialogs and windows. May be NULL. If NULL, IBuilderWizardManager uses the HWND for the application frame window. Note This method may bring up a modal dialog asking the user to choose the builder to use.

pclsidBuilder: Guid

[out] The CLSID of a specific builder.

Returns

Int32

S_OK if the CATID maps to a builder.S_FALSE if there is no builder for the CATID.

Remarks

The caller can control whether there is a user prompt to choose among multiple available builders for a particular CATID. If there is to be no prompt and there is more than one builder available, then IBuilderWizardManager picks a default builder.

Most clients do not need to call this method directly. They can call GetBuilder with the BLDGETOPT_FAUTOMAPGUID flag. Advanced callers may want to retrieve the CLSID for a builder rather than immediately instantiating the builder.

The builder manager’s implementation of MapBuilderCATIDToCLSID may have private knowledge of how to do the mapping for special CATIDs or it may use a general mechanism that looks in the registry.

This method always returns the CLSID of a particular builder.

Applies to