WsWriteStartAttribute-Funktion (webservices.h)

  • Artikel

Dieser Vorgang beginnt mit dem Schreiben eines Attributs in das aktuelle Element. WsWriteStartElement muss aufgerufen werden, bevor ein Attribut geschrieben werden kann. Nachdem das Attribut gestartet wurde, kann der Attributwert mit WsWriteChars, WsWriteBytes oder WsWriteValue geschrieben werden. Das Attribut muss mit WsWriteEndAttribute abgeschlossen werden.

Syntax

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

Parameter

[in] writer

Ein Zeiger auf das WS_XML_WRITER-Objekt , in das das Attribut geschrieben wird. Der Zeiger muss auf ein gültiges XML Writer-Objekt verweisen.

[in, optional] prefix

Ein WS_XML_STRING Zeiger auf das Präfix, das für das Attribut verwendet werden soll. Wenn der Wert, auf den durch diesen Parameter verwiesen wird , NULL ist, wählt writer ein Attribut aus.

[in] localName

Ein WS_XML_STRING Zeiger auf den lokalen Namen, der vom Attribut verwendet wird. Es muss mindestens ein Zeichen lang sein.

[in] ns

Ein WS_XML_STRING Zeiger auf den Namespace, der für das Attribut verwendet werden soll.

Wenn kein Präfix angegeben ist, kann der Writer ein Präfix im Bereich verwenden, das an den angegebenen Namespace gebunden ist, oder er generiert ein Präfix und enthält ein XMLNS-Attribut.

Wenn ein Präfix angegeben wird, verwendet der Writer dieses Präfix und kann bei Bedarf ein XMLNS-Attribut enthalten, um ein vorhandenes Präfix im Bereich außer Kraft zu setzen.

[in] singleQuote

Bestimmt, ob ein einzelnes oder ein doppeltes Anführungszeichen für den Attributwert verwendet werden soll.

Hinweis Bei WS_XML_WRITER_BINARY_ENCODING wird das Anführungszeichen nicht beibehalten, und dieser Parameter hat keine Auswirkung.
 

[in, optional] error

Ein Zeiger auf ein WS_ERROR-Objekt , in dem zusätzliche Informationen zum Fehler gespeichert werden sollen, wenn die Funktion fehlschlägt.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode Beschreibung
E_INVALIDARG
 Mindestens ein Argument ist ungültig.
WS_E_INVALID_OPERATION
 Der Vorgang ist aufgrund des aktuellen Zustands des Objekts nicht zulässig.
WS_E_INVALID_FORMAT
 Die Eingabedaten waren nicht im erwarteten Format oder hatten nicht den erwarteten Wert.
WS_E_QUOTA_EXCEEDED
 Ein Kontingent wurde überschritten.

Hinweise

Wenn ein NULL-Präfix angegeben ist, wählt der Writer ein Präfix für den Namespace aus.

Um ein Attribut "xml:lang" oder "xml:space" zu schreiben, geben Sie "xml" als Präfix, "lang" oder "space" für localName und "http://www.w3.org/XML/1998/namespace" für den Namespace.

Wenn das Schreiben des Attributs dazu führt , dass WS_XML_WRITER_PROPERTY_MAX_ATTRIBUTES überschritten wird, wird WS_E_QUOTA_EXCEEDED zurückgegeben.

Wenn ein nicht leeres Präfix mit einem leeren Namespace angegeben wird , wird WS_E_INVALID_FORMAT zurückgegeben. (Siehe Rückgabewerte für Windows-Webdienste.)

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 7 [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 R2 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile webservices.h
Bibliothek WebServices.lib
DLL WebServices.dll