RemoveHeaderField

TwinCAT TIA
Netzwerk REST Client ActiveClients Ein Client

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

Der Befehl entfernt den angegebenen Header.

Parameter:

    FieldName
    Name des Headers, der entfernt werden soll.

Rückgabewert:

    RemoveHeaderField
    Eine Struktur-Variable vom Typ OpcMethodReturnValueBoolean. In der Eigenschaft Result sind die befehlsspezifischen Rückgabewerte enthalten.
      Result
      Gibt an ob das Header-Element erfolgreich entfernt wurde. Wenn das Header-Element nicht gefunden wurde, wird false zurückgegeben.

Beispiele:

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

Beckhoff Parameter:

    bHttpRemoveHeaderField
    Eine boolesche Variable, über welche die Ausführung des RemoveHeaderField-Befehls getriggert werden kann.
    OutputDataHttpRemoveHeaderField
    Eine Instanz der ST_BoolOutputData Struktur, in welche der Rückgabewert der RemoveHeaderField-Methode geschrieben wird.
    hrHttpRemoveHeaderField
    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 zu entfernenden Header-Elements spezifiziert.
    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
   bHttpRemoveHeaderField   : BOOL;
   OutputDataHttpRemoveHeaderField : ST_BoolOutputData;
   hrHttpRemoveHeaderField   : HRESULT;
 
   fbHttpRest   : FB_HttpRest;
END_VAR

hrHttpRemoveHeaderField := fbHttpRest.RemoveHeaderField(
          bExecute   := bHttpRemoveHeaderField, 
          ConnectionHandle:= depragSmartConnection.ConnectionHandle,
          sFieldName   := 'TestHeaderField',
          sClientId   := '0',
          OutputData  => OutputDataHttpRemoveHeaderField);
IF hrHttpRemoveHeaderField <> S_FALSE THEN 
    bHttpRemoveHeaderField := 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.