Share via


ErrorSupport.GetFormattedMessage(Int32, String, Object[]) Method

Definition

Gets the error message for an HRESULT and formats the message by populating parameters with the supplied values.

public:
 int GetFormattedMessage(int hResult, [Runtime::InteropServices::Out] System::String ^ % strFormattedText, ... cli::array <System::Object ^> ^ paramList);
public int GetFormattedMessage (int hResult, out string strFormattedText, params object[] paramList);
member this.GetFormattedMessage : int * string * obj[] -> int
Public Function GetFormattedMessage (hResult As Integer, ByRef strFormattedText As String, ParamArray paramList As Object()) As Integer

Parameters

hResult
Int32

The HRESULT for which to return the formatted error message.

strFormattedText
String

The formatted error message.

paramList
Object[]

An array of parameter values required for the formatted error message.

Returns

A value that indicates whether the GetFormattedMessage(Int32, String, Object[]) method succeeded or failed. A value of 0 (zero) indicates success.

Applies to