Expand Minimize

WsWriteArray function

This operation sends a series of elements to an XML Writer.

Syntax


HRESULT WINAPI  WsWriteArray(
  _In_      WS_XML_WRITER* writer,
  _In_      const WS_XML_STRING* localName,
  _In_      const WS_XML_STRING* ns,
  _In_      WS_VALUE_TYPE valueType,
  const void* array,
  _In_      ULONG arraySize,
  _In_      ULONG itemOffset,
  _In_      ULONG itemCount,
  _In_opt_  WS_ERROR* error
);

Parameters

writer [in]

A pointer to the Writer where the elements are written.

localName [in]

A pointer to the localName of the repeating element.

ns [in]

A pointer to the namespace of the repeating element.

valueType [in]

The value type for the elements

array

A void pointer to the values written to writer. The size of the items is determined by value type.

Note  See WS_VALUE_TYPE for more information.

arraySize [in]

The total byte length of the array.

itemOffset [in]

The item offset within the array to write.

itemCount [in]

The total number of items to write from the array.

error [in, optional]

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This function is semantically equivalent to using WsWriteStartElement, WsWriteValue and WsWriteEndElement in a loop, but is more efficient.

Requirements

Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

WebServices.h

Library

WebServices.lib

DLL

WebServices.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft