ErrorSupport.FireError Method (Int32, String, String, Int32, Boolean%)

Raises an error identified by the specified HRESULT, associates it with the specified component, help file, and help context, and allows execution to be cancelled.

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

Syntax

'Declaration
Public Sub FireError ( _
    hResult As Integer, _
    strSubComponent As String, _
    strHelpFile As String, _
    HelpContext As Integer, _
    <OutAttribute> ByRef bCancel As Boolean _
)
'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

instance.FireError(hResult, strSubComponent, _
    strHelpFile, HelpContext, bCancel)
public void FireError(
    int hResult,
    string strSubComponent,
    string strHelpFile,
    int HelpContext,
    out bool bCancel
)
public:
void FireError(
    int hResult, 
    String^ strSubComponent, 
    String^ strHelpFile, 
    int HelpContext, 
    [OutAttribute] bool% bCancel
)
member FireError : 
        hResult:int * 
        strSubComponent:string * 
        strHelpFile:string * 
        HelpContext:int * 
        bCancel:bool byref -> unit 
public function FireError(
    hResult : int, 
    strSubComponent : String, 
    strHelpFile : String, 
    HelpContext : int, 
    bCancel : boolean
)

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 will provide additional information about the messages that are raised.
  • HelpContext
    Type: System.Int32
    The location in the help file that will provide additional information about the messages that are raised.
  • bCancel
    Type: System.Boolean%
    true to cancel execution; otherwise, false.