Vcl.DdeMan.TDdeClientConv.PokeData

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function PokeData(const Item: string; Data: PAnsiChar): Boolean;

C++

bool __fastcall PokeData(const System::UnicodeString Item, char * Data);

Properties

Type Visibility Source Unit Parent
function public
Vcl.DdeMan.pas
Vcl.DdeMan.hpp
Vcl.DdeMan TDdeClientConv

Description

Sends data to a DDE server application.

Use PokeData to transfer text data to a DDE server that supports poked data. Item specifies the linked item in the DDE server. Data is a null-terminated string that specifies the text data to transfer.

The value of the DDE item depends on the linked DDE server application. Item is typically a selectable portion of text, such as a spreadsheet cell or a database field in an edit box. If the DDE server is a Delphi C++Builder application, Item is the name of the linked DDE server component.

The usual direction of data flow is from the DDE server to the DDE client application. Some DDE server applications won't accept poked data. PokeData returns true if the data was successfully transferred, false if the data was not successfully transferred.

To poke a string list rather than a single string, use the PokeDataLines method.

Note: If either the ExecuteMacro or ExecuteMacroLines method was called with its WaitFlg parameter set to true, PokeData will automatically fail until the server application has completed executing the macro. The WaitStat property indicates when PokeData will attempt to poke data to the server.

See Also