IVsShell.LoadUILibrary Method

Article
04/22/2008

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

'Déclaration
Function LoadUILibrary ( _
    ByRef guidPackage As Guid, _
    dwExFlags As UInteger, _
    <OutAttribute> ByRef phinstOut As UInteger _
) As Integer
'Utilisation
Dim instance As IVsShell
Dim guidPackage As Guid
Dim dwExFlags As UInteger
Dim phinstOut As UInteger
Dim returnValue As Integer

returnValue = instance.LoadUILibrary(guidPackage, _
    dwExFlags, phinstOut)

int LoadUILibrary(
    ref Guid guidPackage,
    uint dwExFlags,
    out uint phinstOut
)

int LoadUILibrary(
    [InAttribute] Guid% guidPackage, 
    [InAttribute] unsigned int dwExFlags, 
    [OutAttribute] unsigned int% phinstOut
)

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.

Permissions

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.

Partager via