Skip to content

Latest commit

 

History

History
40 lines (35 loc) · 1.95 KB

File metadata and controls

40 lines (35 loc) · 1.95 KB
title Description Property | Microsoft Docs
ms.prod sql
ms.prod_service connectivity
ms.technology connectivity
ms.custom
ms.date 01/19/2017
ms.reviewer
ms.topic conceptual
apitype COM
f1_keywords
Error::Description
Error::GetDescription
Error::get_Description
helpviewer_keywords
Description property
ms.assetid 4b5d6790-6c29-42aa-bf78-d9cfb8ad7965
author MightyPen
ms.author genemi

Description Property

Describes an Error object.

Return Value

Returns a String value that contains a description of the error.

Remarks

Use the Description property to obtain a short description of the error. Display this property to alert the user to an error that you cannot or do not want to handle. The string will come from either ADO or a provider.

Providers are responsible for passing specific error text to ADO. ADO adds an Error object to the Errors collection for each provider error or warning it receives. Enumerate the Errors collection to trace the errors that the provider passes.

Applies To

Error Object

See Also

Description, HelpContext, HelpFile, NativeError, Number, Source, and SQLState Properties Example (VB)
Description, HelpContext, HelpFile, NativeError, Number, Source, and SQLState Properties Example (VC++)
HelpContext, HelpFile Properties
Number Property (ADO)
Source Property (ADO Error)