WsWriteType function (webservices.h)

Article
02/22/2024

Write a value of a given WS_TYPE to XML according to the WS_TYPE_MAPPING.

Syntax

HRESULT WsWriteType(
  [in]           WS_XML_WRITER   *writer,
  [in]           WS_TYPE_MAPPING typeMapping,
  [in]           WS_TYPE         type,
  [in, optional] const void      *typeDescription,
  [in]           WS_WRITE_OPTION writeOption,
                 const void      *value,
  [in]           ULONG           valueSize,
  [in, optional] WS_ERROR        *error
);

Parameters

[in] writer

The writer to write the value to.

[in] typeMapping

Describes how the type maps to the XML that is being written.

[in] type

The type of the value to serialize.

[in, optional] typeDescription

Additional information about the type. Each type has a different description structure. This may be NULL, depending on the WS_TYPE.

[in] writeOption

Whether the value is required, and how the value is allocated. See WS_WRITE_OPTION for more information.

This parameter must have one of the following values:

value

A pointer to the value to serialize.

[in] valueSize

The size of the value being serialized.

[in, optional] error

Specifies where additional error information should be stored if the function fails.

Return value

This function can return one of these values.

Return code	Description
WS_E_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.
E_INVALIDARG	One or more arguments are invalid.
E_OUTOFMEMORY	Ran out of memory.
Other Errors	This function may return other errors not listed above.

Remarks

See WS_TYPE_MAPPING for how to use this function to write values in elements and attributes.

If the API fails, the state of input writer becomes undefined. The only APIs that may be used on the writer if this occurs are WsSetOutput and WsSetOutputToBuffer to return the writer to a usable state, or WsFreeWriter to free the writer.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	webservices.h
Library	WebServices.lib
DLL	WebServices.dll

Share via