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.

WsWriteStartAttribute function

This operation starts writing an attribute to the current element. WsWriteStartElement must be called before an attribute can be written. After the attribute has been started, the attribute value can be written using WsWriteChars, WsWriteBytes, or WsWriteValue. The attribute must be completed using using WsWriteEndAttribute.


HRESULT WINAPI  WsWriteStartAttribute(
  _In_     WS_XML_WRITER*       writer,
  _In_opt_ const WS_XML_STRING* prefix,
  _In_     const WS_XML_STRING* localName,
  _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 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 attribute. If the value referenced by this parameter is NULL the Writer will choose a attribute.

localName [in]

A WS_XML_STRING pointer to the local name used by the attribute. It must be at least one character long.

ns [in]

A WS_XML_STRING pointer to the namespace to be used for the attribute. If no prefix is specified the Writer may use a prefix in scope that is bound to the specified namespace or it may generate a prefix and include an XMLNS attribute. If a prefix is specified the Writer will use that prefix and may include an XMLNS attribute if needed to override an existing prefix in scope.

singleQuote [in]

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

Note  With WS_XML_WRITER_BINARY_ENCODING the quote character is not preserved and this parameter has 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.



If a NULL prefix is specified the writer will choose a prefix for the namespace.

To write an "xml:lang" or "xml:space" attribute, specify "xml" for the prefix, "lang" or "space" for the localName, and "" for the namespace.

If writing the attribute causes WS_XML_WRITER_PROPERTY_MAX_ATTRIBUTES to be exceeded then WS_E_QUOTA_EXCEEDED is returned.

If a non-empty prefix is specified with an empty namespace WS_E_INVALID_FORMAT is returned. (See Windows Web Services Return Values.)


Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

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









Community Additions

© 2017 Microsoft