Get-Methode

Übersicht

 

 

Aufgabe

Die Methode Get initialisiert die Methode HTTP zur Anforderung einer Darstellung 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 Get ist nur im Zustand Connected zulässig.

Implementierungsbeispiel

Das folgende Beispiel zeigt, wie eine HTTP-Anfrage nach dem Aufruf der Methode Get aussieht.

Methodenaufruf:

sAdditionalHeader := 'Content-Type: application/json$r$nConnection: Keep-Alive';

fbHTTP.Get(   i_sRessource:= 'example',
              i_sHost:= 'se.com',
              i_anyAdditionalHeader:= sAdditionalHeader,
              i_anyResponseBuffer:= sResponse);

Resultierende HTTP-Anfrage:

GET /example HTTP/1.1
Host: se.com
Content-Length: 0
Content-Type: application/json
Connection: Keep-Alive

Übergang des Clientzustands

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

Schnittstelle