✕
✕

SetProxy

TwinCAT TIA
Network REST Client ActiveClients One client

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

Sets the proxy server. The proxy server is used for all requests to the API.

Parameters:

    Host
    IP or DNS address of the proxy server.
    Port
    Port of the proxy server.
    UseDefaultCredentials
    Specifies whether to use the system credentials when logging in to the proxy server or to specify the user name and password itself.
    UserName
    User name used to authenticate with the specified proxy server.
    Password
    Password used to authenticate with the specified proxy server.

Returns:

    SetProxy
    A variable of the OpcMethodReturnValueVoid type. The method has no command-specific return values.

Beispiele:

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

Beckhoff Parameter:

    bHttpSetProxy
    Eine boolesche Variable, über welche die Ausführung des SetProxy-Befehls getriggert werden kann.
    OutputDataHttpSetProxy
    Eine Instanz der ST_VoidOutputData Struktur, in welche der Rückgabewert der SetProxy-Methode geschrieben wird.
    hrHttpSetProxy
    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.
    sHost
    Eine String(255)-Variable, in welcher die IP oder DNS-Adresse des Proxy-Servers hinterlegt wird.
    nPort
    Eine DINT-Variable, welche den Port des Proxy-Servers enthält.
    bBypassProxyOnLocal
    Eine boolsche Variable, durch welche der Proxy-Server für lokale Adressen umgangen werden kann.
    bUseDefaultCredentials
    Eine boolsche Variable für die Auswahl zwischen den verwenden der Systemanmeldeinformationen und dem eingeben eines Benutzernamens und Passworts.
    sUserName
    Eine String(255)-Variable, durch welche ein Benutzername zum authentifizieren am Proxy-Server hinterlegt werden kann.
    sPassword
    Eine String(255)-Variable, durch welche ein Passwort zum authentifizieren am Proxy-Server hinterlegt werden kann.
    sDomain
    Eine String(255)-Variable für die Proxy-Server Domain.
    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
 bHttpSetProxy     : BOOL;
 OutputDataHttpSetProxy   : ST_VoidOutputData;
 hrHttpSetProxy    : HRESULT;
 
   fbHttpRest   : FB_HttpRest;
END_VAR

hrHttpSetProxy := fbHttpRest.SetProxy( 
       bExecute    := bHttpSetProxy,
       ConnectionHandle   := depragSmartConnection.ConnectionHandle,
       sHost     := 'TestHost',
       nPort     := 1234,
       bBypassProxyOnLocal  := TRUE,
       bUseDefaultCredentials := TRUE,
       sUserName    := 'User1',
       sPassword    := 'Password123',
       sDomain     := 'http://OpcUa.deprag.com/',
       sClientId    := '0',
       OutputData    => OutputDataHttpSetProxy);
IF hrHttpSetProxy <> S_FALSE THEN
 bHttpSetProxy := 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.