WsWriteXmlnsAttribute function (webservices.h)

Article
10/13/2021

Writes an Xmlns attribute to the current element. WsWriteStartElement must be called before an attribute can be written and if the number of attributes exceeds the maximum number of attributes permitted for the writer the function returns WS_E_QUOTA_EXCEEDED. (See Windows Web Services Return Values.)

Syntax

HRESULT WsWriteXmlnsAttribute(
  [in]           WS_XML_WRITER       *writer,
  [in, optional] const WS_XML_STRING *prefix,
  [in]           const WS_XML_STRING *ns,
  [in]           BOOL                singleQuote,
  [in, optional] WS_ERROR            *error
);

Parameters

[in] writer

A pointer to the WS_XML_WRITER object to which the Xmlns attribute is written. The pointer must reference a valid XML Writer object.

[in, optional] prefix

A WS_XML_STRING pointer to the prefix to use for the start element. If the value referenced by this parameter is NULL the Writer will choose a attribute.

Specifies the prefix to use for the xmlns attribute.

[in] ns

A WS_XML_STRING pointer to the namespace to bind to the prefix.

[in] singleQuote

Determines whether to use a single or a double quote for the attribute value.

Note If WS_XML_WRITER_BINARY_ENCODING is set the quotation character is not preserved and this parameter has have no effect.

[in, optional] error

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

Return value

This function can return one of these values.

Return code	Description
E_INVALIDARG	One or more arguments are invalid.
WS_E_INVALID_OPERATION	The operation is not allowed due to the current state of the object.
WS_E_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.
WS_E_QUOTA_EXCEEDED	A quota was exceeded.

Remarks

The following conditions apply:

If an empty prefix is specified then the default namespace is assigned.
If a NULL prefix is specified then the Writer chooses the appropriate prefix for the namespace.
If the Xmlns attribute is redundant it cannot be written.
If a non-empty prefix is specified with an empty namespace WS_E_INVALID_FORMAT is returned.

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