WsCreateReader-Funktion (webservices.h)

Erstellt einen XML-Reader mit den angegebenen Eigenschaften.

Syntax

HRESULT WsCreateReader(
                 const WS_XML_READER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
                 WS_XML_READER                **reader,
  [in, optional] WS_ERROR                     *error
);

Parameter

properties

Ein Array von WS_XML_READER_PROPERTY Strukturen, die optionale Eigenschaften für den XML-Reader enthalten.

Der Wert dieses Parameters kann NULL sein. In diesem Fall muss der propertyCount-Parameter 0 (null) sein.

Die Eigenschaften, die tiy zum Konfigurieren des XML-Readers verwenden kann, finden Sie in der WS_XML_READER_PROPERTY_ID-Enumeration .

[in] propertyCount

Die Anzahl der Eigenschaften im Eigenschaftenarray .

reader

Bei Erfolg ein Zeiger, der die Adresse der WS_XML_READER Struktur empfängt, die den neuen XML-Reader darstellt.

Wenn Sie diese Struktur nicht mehr benötigen, müssen Sie sie durch Aufrufen von WsFreeReader freigeben.

[in, optional] error

Zeiger auf eine WS_ERROR-Struktur , die zusätzliche Fehlerinformationen empfängt, wenn die Funktion fehlschlägt.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird NO_ERROR zurückgegeben. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Hinweise

Verwenden Sie die Funktionen WsSetInput OderWsSetInputToBuffer , um die Codierung für den XML-Reader auszuwählen und die Quelle der Eingabe anzugeben.

Wenn WS_READ_CALLBACK in der an die WsSetInput-Funktion übergebenenWS_XML_READER_INPUT-Struktur angegeben ist, liest der XML-Reader zusätzliche Daten nur, wenn WsFillReader aufgerufen wird. Dadurch kann der Aufrufer bestimmen, mit welcher Granularität Daten gelesen werden sollen und ob diese Daten asynchron gelesen werden sollen.

Eine WS_XML_READER-Struktur kann wiederverwendet werden, indem WsSetInput oderWsSetInputToBuffer erneut aufgerufen wird.

Wenn ein API-Vorgang, der für einen WS_XML_READER fehlschlägt, wird der XML-Reader in einem fehlerhaften Zustand belassen, und weitere Funktionsaufrufe geben WS_E_OBJECT_FAULTED zurück. (Siehe Rückgabewerte für Windows-Webdienste.) Die einzigen möglichen Funktionsaufrufe für den XML-Reader in diesem Fall sind WsSetInput und WsSetInputToBuffer , um den XML-Reader in einen verwendbaren Zustand zurückzugeben, oder WsFreeReader zum Freigeben des XML-Readerobjekts.

Anforderungen