IVsShell.LoadPackageString(Guid, UInt32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.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.

Directly loads a localized string from a VSPackage satellite DLL.

public:
 int LoadPackageString(Guid % guidPackage, System::UInt32 resid, [Runtime::InteropServices::Out] System::String ^ % pbstrOut);

public int LoadPackageString (ref Guid guidPackage, uint resid, out string pbstrOut);

abstract member LoadPackageString : Guid * uint32 * string -> int

Public Function LoadPackageString (ByRef guidPackage As Guid, resid As UInteger, ByRef pbstrOut As String) As Integer

Parameters

guidPackage: Guid

[in] Unique identifier of the VSPackage whose UI DLL contains the string specified to load.

resid: UInt32

[in] Identifier of the string table resource.

pbstrOut: String

[out, retval] Pointer to the requested string.

Returns

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::LoadPackageString(  
   [in] REFGUID guidPackage,  
   [in] ULONG resid,  
   [out, retval] BSTR *pbstrOut  
);

This method is a helper utility — a shortcut for calling the LoadUILibrary LoadResourceString. The Win API caller is responsible for calling SysFreeString to free the allocated pbstrOut string. This method uses the LoadUILibrary method to load the localized string as a string resource. You can also manually load the string resource.

Applies to

Share via