DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / DicomGlobal Class / Echo Method

Remote entity name as IP address or resolvable name

Port to connect to

Calling Application Entity Titles (AETs)

Called Application Entity Titles (AETs)

Optional Local IP Address to use for binding the outbound Socket






In This Topic
    Echo Method (DicomGlobal)
    In This Topic
    Sends a DICOM verify (C-ECHO), with IP address, port number, callingAET, calledAET to another application entity, and returns the result
    Sends a DICOM verify (C-ECHO) and returns the result
    Syntax
    'Declaration
     
    
    Public Shared Function Echo( _
       ByVal Node As System.String, _
       ByVal Port As System.Integer, _
       ByVal CallingAET As System.String, _
       ByVal CalledAET As System.String, _
       Optional ByVal LocalIP As System.String _
    ) As System.Integer
    'Usage
     
    
    Dim Node As System.String
    Dim Port As System.Integer
    Dim CallingAET As System.String
    Dim CalledAET As System.String
    Dim LocalIP As System.String
    Dim value As System.Integer
     
    value = DicomGlobal.Echo(Node, Port, CallingAET, CalledAET, LocalIP)
    public static System.int Echo( 
       System.string Node,
       System.int Port,
       System.string CallingAET,
       System.string CalledAET,
       System.string LocalIP
    )
    public function Echo( 
        Node: System.String;
        Port: System.Integer;
        CallingAET: System.String;
        CalledAET: System.String;
        LocalIP: System.String
    ): System.Integer; static; 
    public static function Echo( 
       Node : System.String,
       Port : System.int,
       CallingAET : System.String,
       CalledAET : System.String,
       LocalIP : System.String
    ) : System.int;
    public: static System.int Echo( 
       System.string* Node,
       System.int Port,
       System.string* CallingAET,
       System.string* CalledAET,
       System.string* LocalIP
    ) 
    public:
    static System.int Echo( 
       System.String^ Node,
       System.int Port,
       System.String^ CallingAET,
       System.String^ CalledAET,
       System.String^ LocalIP
    ) 

    Parameters

    Node

    Remote entity name as IP address or resolvable name

    Port

    Port to connect to

    CallingAET

    Calling Application Entity Titles (AETs)

    CalledAET

    Called Application Entity Titles (AETs)

    LocalIP
    Optional Local IP Address to use for binding the outbound Socket

    Return Value

    The status provided by the SCP. This should always be 0
    Remarks

    Although in theory the remote entity may return a status other than 0 to indicate an error, in most circumstances (such as remote machine turned off), this method will fail with a trappable error, such as "Fail to connection at TCP level"

    When certificate is used, a secure association will be attempted using TLS. If certificate is a valid x509 certificate, then user authentication will be used, but if it is null, then an anonymous client association will be attempted, which may or may not be accepted by the SCP.

    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also