IVsUIShell2::VsDialogBoxParam Method (UInt32, UInt32, UInt32, Int32)

Visual Studio 2015

Loads and displays the specified dialog template using the specified dialog callback procedure.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

C++

int VsDialogBoxParam(
	unsigned int hinst,
	unsigned int dwId,
	unsigned int lpDialogFunc,
	int lp
)

Parameters

hinst: Type: System::UInt32
[in] 32-bit handle to the module that contains the dialog template as a resource. Cannot be a null value.

dwId: Type: System::UInt32
[in] The resource ID of the dialog template to load.

lpDialogFunc: Type: System::UInt32
[in] The dialog procedure to use for the dialog box. Cannot be a null value.

lp: Type: System::Int32
[in] The LPARAM value to pass with the WM_INITDIALOG message (which is sent to the dialog procedure).

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

C++

HRESULT IVsUIShell2::VsDialogBoxParam(
   [in] HINSTANCE hinst,
   [in] DWORD     dwId,
   [in] DLGPROC   lpDialogFunc,
   [in] LPARAM    lp
);

This method overrides the help button normally displayed in the title bar of the dialog box with a button that calls up normal help instead of starting a context-sensitive help mode.

This method is designed to be used from C++ only.