WsCreateReader 函式 (webservices.h)

  • 發行項

使用指定的屬性建立 XML 讀取器 。

語法

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

參數

properties

包含 XML 讀取器選擇性屬性 之WS_XML_READER_PROPERTY 結構的數位。

此參數的值可能是 NULL，在此情況下， propertyCount 參數必須是 0 (零) 。

如需 tiy 可用來設定 XML 讀取器的屬性，請參閱 WS_XML_READER_PROPERTY_ID 列舉。

[in] propertyCount

屬性陣列中的 屬性 數目。

reader

成功時，會接收表示新 XML 讀取器 之WS_XML_READER 結構的位址指標。

當您不再需要此結構時，您必須呼叫 WsFreeReader 來釋放它。

[in, optional] error

WS_ERROR 結構的指標，如果函式失敗，則會接收其他錯誤資訊。

傳回值

如果函式成功，它會傳回NO_ERROR;否則，它會傳回 HRESULT 錯誤碼。

備註

使用 WsSetInput 或 WsSetInputToBuffer 函式來選擇 XML 讀取器的編碼方式，並指出輸入的來源。

如果在傳遞至 WsSetInput 函式的 WS_XML_READER_INPUT 結構中指定WS_READ_CALLBACK，XML 讀取器只會在呼叫 WsFillReader 時讀取其他數據。 這可讓呼叫端判斷讀取數據的數據粒度，以及是否以異步方式讀取該數據。

您可以再次呼叫 WsSetInput 或 WsSetInputToBuffer 來重複使用WS_XML_READER結構。

如果任何在 WS_XML_READER 上運作的 API 作業失敗，XML 讀取器就會處於錯誤狀態，而進一步的函式呼叫會傳回 WS_E_OBJECT_FAULTED。 (請參閱 Windows Web Services 傳回 Values.) 發生此情況時，XML 讀取器的唯一可能函數呼叫是 WsSetInput 和 WsSetInputToBuffer，以便將 XML 讀取器傳回至可用狀態，或 WsFreeReader 用於釋放 XML 讀取器物件。

規格需求

需求 值
最低支援的用戶端 Windows 7 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2008 R2 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 webservices.h
程式庫 WebServices.lib
Dll WebServices.dll