IVsShell.LoadUILibrary Method

Triggers the satellite DLL to load if it has not already done so.

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

Syntax

'Declaration
Function LoadUILibrary ( _
    ByRef guidPackage As Guid, _
    dwExFlags As UInteger, _
    <OutAttribute> ByRef phinstOut As UInteger _
) As Integer
int LoadUILibrary(
    ref Guid guidPackage,
    uint dwExFlags,
    out uint phinstOut
)
int LoadUILibrary(
    [InAttribute] Guid% guidPackage, 
    [InAttribute] unsigned int dwExFlags, 
    [OutAttribute] unsigned int% phinstOut
)
abstract LoadUILibrary : 
        guidPackage:Guid byref * 
        dwExFlags:uint32 * 
        phinstOut:uint32 byref -> int
function LoadUILibrary(
    guidPackage : Guid, 
    dwExFlags : uint, 
    phinstOut : uint
) : int

Parameters

  • guidPackage
    Type: System.Guid%

    [in] Unique identifier of the satellite DLL to be loaded.

  • dwExFlags
    Type: System.UInt32

    [in] Flags that are directly passed to the Microsoft Win32 LoadLibrary API.

  • phinstOut
    Type: System.UInt32%

    [out, retval] Pointer to the HINSTANCE of the loaded library.

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 vsshell.idl:

HRESULT IVsShell::LoadUILibrary(
   [in] REFGUID guidPackage,
   [in] DWORD dwExFlags,
   [out, retval] DWORD_PTR *phinstOut
);

The environment knows which language locale you are running under and loads the appropriate DLL. Your VSPackage calls this method in your SetSite to get access to your own resources.

.NET Framework Security

See Also

Reference

IVsShell Interface

Microsoft.VisualStudio.Shell.Interop Namespace