SqlCommand.ExecuteXmlReaderAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, определенной в данном объекте SqlCommand, и возвращает результаты в виде объекта XmlReader.
Перегрузки
| ExecuteXmlReaderAsync() |
Асинхронная версия ExecuteXmlReader(), которая отправляет CommandText в Connection и создает объект XmlReader. Сведения об исключениях передаются в возвращенном объекте Task. |
| ExecuteXmlReaderAsync(CancellationToken) |
Асинхронная версия ExecuteXmlReader(), которая отправляет CommandText в Connection и создает объект XmlReader. Токен отмены можно использовать для запроса отказа от операции до истечения времени ожидания команды. Сведения об исключениях передаются в возвращенном объекте Task. |
ExecuteXmlReaderAsync()
Асинхронная версия ExecuteXmlReader(), которая отправляет CommandText в Connection и создает объект XmlReader.
Сведения об исключениях передаются в возвращенном объекте Task.
public:
System::Threading::Tasks::Task<System::Xml::XmlReader ^> ^ ExecuteXmlReaderAsync();public System.Threading.Tasks.Task<System.Xml.XmlReader> ExecuteXmlReaderAsync ();member this.ExecuteXmlReaderAsync : unit -> System.Threading.Tasks.Task<System.Xml.XmlReader>Public Function ExecuteXmlReaderAsync () As Task(Of XmlReader)Возвращаемое значение
Задача, представляющая асинхронную операцию.
Исключения
Объект , отличный SqlDbType от Binary или VarBinary , использовался, если Value для параметра задано значение Stream. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
-или-
Значение , отличное SqlDbType от Char, NChar, NVarChar, VarChar или Xml , использовалось, если Value для параметра задано значение TextReader.
-или-
Объект , отличный SqlDbType от XML , использовался, если Value для параметра задано значение XmlReader.
Вызов ExecuteScalarAsync(CancellationToken) более одного раза для того же экземпляра до завершения задачи.
-или-
Подключение SqlConnection, закрытое или удаленное во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
-или-
Context Connection=true задается в строке подключения.
SQL Server вернул ошибку во время выполнения текста команды.
-или-
Во время операции потоковой передачи истекло время ожидания. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Во время операции потоковой передачи возникла ошибка в объекте Stream, XmlReader или TextReader. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Объект Stream, XmlReader или TextReader был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Комментарии
XmlReader, возвращаемый этим методом, не поддерживает асинхронные операции.
Дополнительные сведения об асинхронном программировании в поставщике данных платформа .NET Framework для SQL Server см. в статье Асинхронное программирование.
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые ExecuteXmlReader().
См. также раздел
Применяется к
ExecuteXmlReaderAsync(CancellationToken)
Асинхронная версия ExecuteXmlReader(), которая отправляет CommandText в Connection и создает объект XmlReader.
Токен отмены можно использовать для запроса отказа от операции до истечения времени ожидания команды. Сведения об исключениях передаются в возвращенном объекте Task.
public:
System::Threading::Tasks::Task<System::Xml::XmlReader ^> ^ ExecuteXmlReaderAsync(System::Threading::CancellationToken cancellationToken);public System.Threading.Tasks.Task<System.Xml.XmlReader> ExecuteXmlReaderAsync (System.Threading.CancellationToken cancellationToken);member this.ExecuteXmlReaderAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Xml.XmlReader>Public Function ExecuteXmlReaderAsync (cancellationToken As CancellationToken) As Task(Of XmlReader)Параметры
- cancellationToken
- CancellationToken
Инструкция отмены.
Возвращаемое значение
Задача, представляющая асинхронную операцию.
Исключения
Объект , отличный SqlDbType от Binary или VarBinary , использовался, если Value для параметра задано значение Stream. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
-или-
Значение , отличное SqlDbType от Char, NChar, NVarChar, VarChar или Xml , использовалось, если Value для параметра задано значение TextReader.
-или-
Объект , отличный SqlDbType от XML , использовался, если Value для параметра задано значение XmlReader.
Вызов ExecuteScalarAsync(CancellationToken) более одного раза для того же экземпляра до завершения задачи.
-или-
Подключение SqlConnection, закрытое или удаленное во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
-или-
Context Connection=true задается в строке подключения.
SQL Server вернул ошибку во время выполнения текста команды.
-или-
Во время операции потоковой передачи истекло время ожидания. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Во время операции потоковой передачи возникла ошибка в объекте Stream, XmlReader или TextReader. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Объект Stream, XmlReader или TextReader был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
XmlReader, возвращаемый этим методом, не поддерживает асинхронные операции.
Дополнительные сведения об асинхронном программировании в поставщике данных платформа .NET Framework для SQL Server см. в статье Асинхронное программирование.
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые ExecuteXmlReader().
