Share via


IVsInstalledProduct.ProductID(String) Method

Definition

Obtains a pointer to the string containing the ID of the product that is displayed in the About dialog box on the Help menu. Not called for the splash screen.

public:
 int ProductID([Runtime::InteropServices::Out] System::String ^ % pbstrPID);
int ProductID([Runtime::InteropServices::Out] std::wstring const & & pbstrPID);
public int ProductID (out string pbstrPID);
abstract member ProductID : string -> int
Public Function ProductID (ByRef pbstrPID As String) As Integer

Parameters

pbstrPID
String

[out] Pointer to the string that identifies the product ID.

Returns

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::ProductID(  
   [out, retval] BSTR *pbstrPID  
);  

IVsInstalledProduct.ProductID gets the number that is displayed in the Installed Products section of About dialog box. Generally, this method is used to show a product identifier that the customer can use when communicating with the client's product support services.

Applies to