IVsInstalledProduct.OfficialName(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.

Obtains a pointer to the string containing the official name of the product that is displayed in the splash screen and About dialog box on the Help menu.

public:
 int OfficialName([Runtime::InteropServices::Out] System::String ^ % pbstrName);

int OfficialName([Runtime::InteropServices::Out] std::wstring const & & pbstrName);

public int OfficialName (out string pbstrName);

abstract member OfficialName : string -> int

Public Function OfficialName (ByRef pbstrName As String) As Integer

Parameters

pbstrName: String

[out] Pointer to the string to be displayed in the splash screen and About dialog box.

Returns

Int32

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

Examples

You can place the hard-coded paths and strings used by this method in your project's resource file.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsInstalledProduct::OfficialName(  
   [out, retval] BSTR *pbstrName  
);

IVsInstalledProduct.OfficialName is used to display the product name shown in the splash screen and About dialog box. If you only want to provide information in the About dialog box and do not want to support the splash screen then do not implement IVsInstalledProduct. Information can be added to the About dialog box alone using the registry.

Applies to

Share via