ErrorSupport.GetFormattedMessage Method

Article
12/03/2008

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 Function GetFormattedMessage ( _
    hResult As Integer, _
    <OutAttribute> ByRef strFormattedText As String, _
    ParamArray paramList As Object() _
) As Integer

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

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

public int GetFormattedMessage (
    int hResult, 
    /** @attribute OutAttribute() */ /** @ref */ String strFormattedText, 
    Object[] paramList
)

JScript does not support passing value-type arguments by reference.

Parameters

hResult
The HRESULT for which to return the formatted error message.

strFormattedText
The formatted error message.

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

Return Value

A value that indicates whether the GetFormattedMessage method succeeded or failed. A value of 0 (zero) indicates success.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via