Head-Methode

Übersicht

Typ

Method

Verfügbar ab

V1.0.0.0

G-SE-0078601.1.gif-high.gif

 

 

Aufgabe

Die Methode Head initialisiert die HTTP-Methode zur Anforderung einer Darstellung des Headers der angegebenen Ressource.

Funktionsbeschreibung

Durch Verwendung der Eingänge i_sHost (obligatorisch) und i_sResource wird der Standard-Header einer HTTP-Anfrage erstellt. Wenn zusätzliche Informationen im Header hinzugefügt werden müssen, müssen diese über den Eingang i_anyAdditionalHeader übergeben werden. Die diesem Eingang zugewiesenen Daten werden nicht geprüft. Am Eingang i_anyResponseBuffer müssen Sie einen Puffer mit ausreichender Größe zur Speicherung der gesamten vom Server empfangenen Antwort zuweisen.

Der Rückgabewert der Methode ist vom Typ BOOL und gibt an, ob die Ausführung der Methode erfolgreich war (TRUE) oder nicht (FALSE). Werten Sie die Diagnoseausgänge der Methode aus, wenn der Rückgabewert FALSE sein sollte. Ein von diesen Ausgängen signalisierter Fehler braucht nicht zurückgesetzt zu werden. Zum Abrufen des Verarbeitungsstatus muss die Eigenschaft State verwendet werden.

Ein Aufruf der Methode Head ist nur im Zustand Connected zulässig.

Übergang des Clientzustands

Schritt

Beschreibung

1

Ausgangszustand: Connected

2

Funktionsaufruf

3

Zustand: SendingRequest, andernfalls wird ein Fehler erkannt.

4

Endzustand: ResponseAvailable, andernfalls wird ein Fehler erkannt.

HINWEIS: Wenn Online-Änderungen vorgenommen werden, während der Funktionsbaustein eine Head-Anfrage verarbeitet, wird die Ausführung abgebrochen, um eine potenzielle Zugriffsver­letzung durch die Verarbeitung fehlerhafter Zeigeradressen zu vermeiden.

Schnittstelle

Eingang

Datentyp

Beschreibung

i_sResource

STRING[GPL.Gc_uiMaxLengthOfResource]

Gibt die Ressource auf dem Host an, die über die Anfrage erreicht werden soll.

i_sResource

STRING[GPL.Gc_uiMaxLengthOfResource]

Gibt die Ressource auf dem Host an, die über die Anfrage erreicht werden soll.

i_sHost

STRING[GPL.Gc_uiMaxHostSize]

Gibt die Adresse des Hosts an, falls erforderlich in Verbindung mit dem Port.

i_anyAdditionalHeader

ANY_STRING

Gibt die zur HTTP-Anfrage hinzuzufügenden zusätzlichen Header an.

i_anyResponseBuffer

ANY

Puffer zur Speicherung der Antwort vom Server.

Ausgang

Datentyp

Beschreibung

q_xError

BOOL

Wenn dieser Ausgang auf TRUE gesetzt wird, wurde ein Fehler identifiziert. Für weitere Informationen, siehe q_etResult und q_etResultMsg,

q_etResult

ET_Result

Stellt Diagnose- und Statusinformationen in Form numerischer Werte bereit.

q_sResultMsg

STRING[80]

Stellt zusätzliche Diagnose- und Statusinformationen in Form von Textmeldungen bereit.