ErrorSupport.GetFormattedMessageEx Method

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

Namespace:  Microsoft.SqlServer.Dts.ManagedMsg
Assembly:  Microsoft.SqlServer.DtsMsg (in Microsoft.SqlServer.DtsMsg.dll)

Syntax

'Declaration
Public Shared Function GetFormattedMessageEx ( _
    hResult As Integer, _
    <OutAttribute> ByRef strFormattedText As String, _
    ParamArray paramList As Object() _
) As Integer
'Usage
Dim hResult As Integer 
Dim strFormattedText As String 
Dim paramList As Object()
Dim returnValue As Integer 

returnValue = ErrorSupport.GetFormattedMessageEx(hResult, _
    strFormattedText, paramList)

public static int GetFormattedMessageEx(
    int hResult,
    out string strFormattedText,
    params Object[] paramList
)

public:
static int GetFormattedMessageEx(
    int hResult, 
    [OutAttribute] String^% strFormattedText, 
    ... array<Object^>^ paramList
)

static member GetFormattedMessageEx : 
        hResult:int * 
        strFormattedText:string byref * 
        paramList:Object[] -> int

public static function GetFormattedMessageEx(
    hResult : int, 
    strFormattedText : String, 
    ... paramList : Object[]
) : int

Parameters

• hResult
  Type: System.Int32
  The HRESULT for which to return the formatted error message.

• strFormattedText
  Type: System.String%
  The formatted error message.

• paramList
  Type: array<System.Object[]
  An array of parameter values required for the formatted error message.

Return Value

Type: System.Int32
A value that indicates whether the method succeeded or failed.

See Also

Reference

ErrorSupport Class

Microsoft.SqlServer.Dts.ManagedMsg Namespace