Data.DBXTransport.TTransportFilter.SetConfederateParameter

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
Data.DBXTransport.pas
Data.DBXTransport.hpp
Unit: Data.DBXTransport
Parent: TTransportFilter

Delphi

function SetConfederateParameter(const ParamName: string; const ParamValue: string): Boolean; virtual;

C++

virtual bool __fastcall SetConfederateParameter(const System::UnicodeString ParamName, const System::UnicodeString ParamValue);

Description

Used by the communication layer, with the partner parameter values.

The SetConfederateParameter method is called by the communication layer, with the partner parameter values. Such values may contain public keys, authentication tokens, and so on, which can be used to encrypt or decrypt the messages.

ParamName represents the name of the parameter while ParamValue represents the value of the parameter.

SetConfederateParameter returns True if the parameter and value are valid, False otherwise. If SetConfederateParameter returns False, the protocol should not continue the communication.

See Also