IBuilderWizardManager.MapObjectToBuilderCLSID Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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 builder for an OLE object given the object's CLSID.

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

public int MapObjectToBuilderCLSID (ref Guid rclsidObject, uint dwPromptOpt, IntPtr hwndPromptOwner, out Guid pclsidBuilder);

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

Public Function MapObjectToBuilderCLSID (ByRef rclsidObject As Guid, dwPromptOpt As UInteger, hwndPromptOwner As IntPtr, ByRef pclsidBuilder As Guid) As Integer

Parameters

rclsidObject: Guid

[in] CLSID of the object

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 CLSID maps to a builder.S_FALSE if there is no builder for the CLSID.

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.

A container calls this method when inserting a control to discover if there is a control builder to run. If so, the container calls GetBuilder to get the builder.

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

This method always returns the CLSID of a particular builder.

Applies to

Share via