GetFormattedMessage メソッド

HRESULT に対応するエラー メッセージを取得し、指定した値をパラメータに設定することでメッセージの形式を設定します。

名前空間:  Microsoft.SqlServer.Dts.ManagedMsg
アセンブリ:  Microsoft.SqlServer.DtsMsg (Microsoft.SqlServer.DtsMsg.dll)

構文

'宣言
Public Function GetFormattedMessage ( _
    hResult As Integer, _
    <OutAttribute> ByRef strFormattedText As String, _
    ParamArray paramList As Object() _
) As Integer
'使用
Dim instance As ErrorSupport
Dim hResult As Integer
Dim strFormattedText As String
Dim paramList As Object()
Dim returnValue As Integer

returnValue = instance.GetFormattedMessage(hResult, _
    strFormattedText, paramList)
public int GetFormattedMessage(
    int hResult,
    out string strFormattedText,
    params Object[] paramList
)
public:
int GetFormattedMessage(
    int hResult, 
    [OutAttribute] String^% strFormattedText, 
    ... array<Object^>^ paramList
)
member GetFormattedMessage : 
        hResult:int * 
        strFormattedText:string byref * 
        paramList:Object[] -> int 
public function GetFormattedMessage(
    hResult : int, 
    strFormattedText : String, 
    ... paramList : Object[]
) : int

パラメーター

  • hResult
    型: System. . :: . .Int32
    形式を設定したエラー メッセージを返す対象の HRESULT です。
  • paramList
    型: array<System. . :: . .Object> [] () [] []
    形式を設定したエラー メッセージに必要なパラメータ値の配列です。

戻り値

型: System. . :: . .Int32
GetFormattedMessage メソッドが成功したか失敗したかを示す値です。値が 0 (ゼロ) の場合は、成功を示します。