✕
✕

AddHeaderField

TwinCAT TIA
Netzwerk REST Client ActiveClients Ein Client

ns=2;s=DEPRAG Smart/Network/HTTP/REST/ActiveClients/0/AddHeaderField

Der Befehl fügt ein neues Header-Element im Request hinzu.

Parameter:

    FieldName
    Name des Headers, der hinzugefügt werden soll.
    Value
    Wert des Headers, der hinzugefügt werden soll.

Rückgabewert:

    AddHeaderField
    Eine Variable vom Typ OpcMethodReturnValueVoid. Die Methode hat keine befehlsspezifischen Rückgabewerte.

Beispiele:

Neben den bereits erläuterten Parametern sind für die Implementierung in TwinCAT 3 nachfolgende Variablen anzulegen / zu übergeben:

Beckhoff Parameter:

    bHttpAddHeaderField
    Eine boolesche Variable, über welche die Ausführung des AddHeaderField-Befehls getriggert werden kann.
    OutputDataHttpAddHeaderField
    Eine Instanz der ST_VoidOutputData Struktur, in welche der Rückgabewert der AddHeaderField-Methode geschrieben wird.
    hrHttpAddHeaderField
    Hiermit kann die Ausführung des Befehls überwacht werden. Fehler-Codes haben den Typ HRESULT.
    fbHttpRest
    Eine Instanz des, mit der DEPRAG Smart-Bibliothek gelieferten, "FB_HttpRest" Funktionsbausteins.
    sFieldName
    Eine String(255)-Variable, welche den Namen des Header-Elements, welches im Request hinzugefügt werden soll, spezifiziert.
    sValue
    Eine String(255)-Variable, welche den Wert des hinzuzufügenden Header-Elements enthält.
    sClientId
    Eine String(255)-Variable, welche den Client spezifiziert, der den Befehl ausführen soll.
    ConnectionHandle
    Beim Verbindungsaufbau zwischen DEPRAG Smart Server und Ihrem OPC UA Client erhaltenes "ConnectionHandle". 


VAR
   bHttpAddHeaderField   : BOOL;
   OutputDataHttpAddHeaderField: ST_VoidOutputData;
   hrHttpAddHeaderField  : HRESULT;
 
   fbHttpRest   : FB_HttpRest;
END_VAR

hrHttpAddHeaderField := fbHttpRest.AddHeaderField(
          bExecute   := bHttpAddHeaderField, 
          ConnectionHandle:= depragSmartConnection.ConnectionHandle,
          sFieldName   := 'TestHeaderField',
          sValue   := 'TestValueHeaderField',
          sClientId   := '0',
          OutputData  => OutputDataHttpAddHeaderField);
IF hrHttpAddHeaderField <> S_FALSE THEN 
    bHttpAddHeaderField := FALSE;
END_IF

Für Beispiele und Erklärungen bezüglich der Aufrufe von Knoten via Siemens TIA Portal sei an dieser Stelle auf den Unterpunkt "Siemens TIA Portal" in Abschnitt "Erste Schritte" verwiesen.