IComponentErrorInfo.GetMessage Method (Boolean)
Returns a String that contains the error message.
Namespace: Microsoft.SqlServer.Dts.Design
Assembly: Microsoft.SqlServer.Dts.Design (in Microsoft.SqlServer.Dts.Design.dll)
Syntax
'Declaration
Function GetMessage ( _
descriptionOnly As Boolean _
) As String
'Usage
Dim instance As IComponentErrorInfo
Dim descriptionOnly As Boolean
Dim returnValue As String
returnValue = instance.GetMessage(descriptionOnly)
string GetMessage(
bool descriptionOnly
)
String^ GetMessage(
bool descriptionOnly
)
abstract GetMessage :
descriptionOnly:bool -> string
function GetMessage(
descriptionOnly : boolean
) : String
Parameters
- descriptionOnly
Type: System.Boolean
A Boolean that indicates whether the error message only is returned, or the error message plus component and subcomponent information.
Return Value
Type: System.String
When true, a String that contains the error message. When false, a String that contains the error message, component and subcomponent information.
Remarks
Passing false to this method is the same as calling the GetMessage method.