Windows apps
Collapse the table of content
Expand the table of content
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

WsWriteXmlnsAttribute function

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.)


HRESULT WINAPI  WsWriteXmlnsAttribute(
  _In_     WS_XML_WRITER*       writer,
  _In_opt_ const WS_XML_STRING* prefix,
  _In_     const WS_XML_STRING* ns,
  _In_     BOOL                 singleQuote,
  _In_opt_ WS_ERROR*            error


writer [in]

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

prefix [in, optional]

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.

ns [in]

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

singleQuote [in]

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.
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

This function can return one of these values.

Return codeDescription

One or more arguments are invalid.


The operation is not allowed due to the current state of the object.


The input data was not in the expected format or did not have the expected value.


A quota was exceeded.



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.


Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

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









Community Additions

© 2016 Microsoft