IVsInstalledProduct::OfficialName Method (String^)

Visual Studio 2015

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.

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

Syntax

C++

int OfficialName(
	[OutAttribute] String^% pbstrName
)

Parameters

pbstrName: Type: System::String^
[out] Pointer to the string to be displayed in the splash screen and About dialog box.

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:

C++

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.

Examples

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