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

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Dts.ManagedMsg
Assembly:
Microsoft.SqlServer.DtsMsg.dll

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

public:
 static int GetFormattedMessageEx(int hResult, [Runtime::InteropServices::Out] System::String ^ % strFormattedText, ... cli::array <System::Object ^> ^ paramList);
public static int GetFormattedMessageEx (int hResult, out string strFormattedText, params object[] paramList);
static member GetFormattedMessageEx : int * string * obj[] -> int
Public Shared Function GetFormattedMessageEx (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

Int32

A value that indicates whether the method succeeded or failed.

Applies to