Datasnap.DSServer.TDSServer.NotifyObject

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function NotifyObject(const ChannelName: string;
const ClientId: string;
const CallbackId: string;
const Msg: TObject; out Response: TObject;
Timeout: Cardinal = INFINITE): Boolean; overload; deprecated 'ChannelName is no longer required';
function NotifyObject(const ClientId: string;
const CallbackId: string;
const Msg: TObject; out Response: TObject;
Timeout: Cardinal = INFINITE): Boolean; overload;

C++

bool __fastcall NotifyObject _DEPRECATED_ATTRIBUTE1("ChannelName is no longer required") (const System::UnicodeString ChannelName, const System::UnicodeString ClientId, const System::UnicodeString CallbackId, System::TObject* const Msg, /* out */ System::TObject* &Response, unsigned Timeout = (unsigned)(0xffffffff))/* overload */;
bool __fastcall NotifyObject(const System::UnicodeString ClientId, const System::UnicodeString CallbackId, System::TObject* const Msg, /* out */ System::TObject* &Response, unsigned Timeout = (unsigned)(0xffffffff))/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Datasnap.DSServer.pas
Datasnap.DSServer.hpp
Datasnap.DSServer TDSServer

Description

Performs synchronous object delivery to a callback.

The NotifyObject method performs synchronous object delivery to a callback located in a client channel. NotifyObject returns True if the delivery was successful, False otherwise. Call NotifyObject with the ChannelName, ClientId, CallbackId, Msg, Response, and Timeout parameters.

ChannelName represents the name of the channel callback.

ClientId represents the identifier of the client channel callback.

CallbackId is a string representing the identifier of the callback.

Msg is a TObject containing the object to be broadcasted.

Response is a TObject containing the response from the channel callback.

Timeout represents the time-out interval in milliseconds. By default it is set to INFINITE.

See Also