IVsUIShell2.VsDialogBoxParam Method

Article
2013-02-04

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

'Declaration
Function VsDialogBoxParam ( _
    hinst As UInteger, _
    dwId As UInteger, _
    lpDialogFunc As UInteger, _
    lp As Integer _
) As Integer

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

int VsDialogBoxParam(
    [InAttribute] unsigned int hinst, 
    [InAttribute] unsigned int dwId, 
    [InAttribute] unsigned int lpDialogFunc, 
    [InAttribute] int lp
)

abstract VsDialogBoxParam : 
        hinst:uint32 * 
        dwId:uint32 * 
        lpDialogFunc:uint32 * 
        lp:int -> int

function VsDialogBoxParam(
    hinst : uint, 
    dwId : uint, 
    lpDialogFunc : uint, 
    lp : int
) : int

Parameters

hinst
Type: System.UInt32
[in] 32-bit handle to the module that contains the dialog template as a resource. Cannot be a nulla null reference (Nothing in Visual Basic) 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 nulla null reference (Nothing in Visual Basic) 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:

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via