• Article

ErrorSupport.FireErrorWithArgs Method (Int32, String, String, Int32, Boolean%, array<Object[])

Raises an error identified by the specified HRESULT, associates it with the specified component, help file, and help context, allows execution to be cancelled, and includes an optional array of user-defined objects or information.

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

Syntax

'Declaration
Public Sub FireErrorWithArgs ( _
    hResult As Integer, _
    strSubComponent As String, _
    strHelpFile As String, _
    HelpContext As Integer, _
    <OutAttribute> ByRef bCancel As Boolean, _
    ParamArray paramList As Object() _
)
'Usage
Dim instance As ErrorSupport
Dim hResult As Integer
Dim strSubComponent As String
Dim strHelpFile As String
Dim HelpContext As Integer
Dim bCancel As Boolean
Dim paramList As Object()

instance.FireErrorWithArgs(hResult, strSubComponent, _
    strHelpFile, HelpContext, bCancel, _
    paramList)

public void FireErrorWithArgs(
    int hResult,
    string strSubComponent,
    string strHelpFile,
    int HelpContext,
    out bool bCancel,
    params Object[] paramList
)

public:
void FireErrorWithArgs(
    int hResult, 
    String^ strSubComponent, 
    String^ strHelpFile, 
    int HelpContext, 
    [OutAttribute] bool% bCancel, 
    ... array<Object^>^ paramList
)

member FireErrorWithArgs : 
        hResult:int * 
        strSubComponent:string * 
        strHelpFile:string * 
        HelpContext:int * 
        bCancel:bool byref * 
        paramList:Object[] -> unit 

public function FireErrorWithArgs(
    hResult : int, 
    strSubComponent : String, 
    strHelpFile : String, 
    HelpContext : int, 
    bCancel : boolean, 
    ... paramList : Object[]
)

Parameters

  • hResult
    Type: System.Int32
    The HRESULT of the underlying COM error.
  • strSubComponent
    Type: System.String
    The friendly name of the component.
  • strHelpFile
    Type: System.String
    The help file that provides additional information about the messages that are raised.
  • HelpContext
    Type: System.Int32
    The location in the help file that provides additional information about the messages that are raised.
  • bCancel
    Type: System.Boolean%
    true to cancel execution; otherwise, false.
  • paramList
    Type: array<System.Object[]
    An optional array of user-defined objects or information.