## Description

Include file: xdde.h

### Overview

XDDE supports "dynamic data exchange". An instance of XDDE can be server or client, it should be possible to create two or more XDDEïs for one window. See OS/2 documentation for details.

### Functions

#### AdviseRequested

#### Parameters

char * itemName | the name of the requested item
SHORT format | format of the data
OOL_WINDOWHANDLE | handle of the client

#### Remarks

Informs a server that an advise is requested. Override this function if you need this information.

#### Connected

#### Parameters

OOL_WINDOWHANDLE handle of the client

#### Remarks

Informs a server that a client has been connected. Override this function if you need this information.

#### DataReceived

#### Parameters

ULONG size | size of the data
void * data | buffer which holds the data
char * itemName | item name
SHORT format | format of the data

#### Remarks

Informs that datas has been received. Override this function if you need this information.

#### DataRequested

#### Parameters

char * itemName | item name
SHORT format | format of the data
OOL_WINDOWHANDLE | the clients handle

#### Remarks

Informs a server that datas are needed. Override this function if you need this information.

#### DisConnected

#### Remarks

Informs that the xdde-instance has no more connections. Override this function if you need this information.

#### InitPossible

#### Parameters

char * appName applivcation name of the possible server
char * toppicname toppic-name that the possible server supports

#### Return-Value

BOOL connect

#### Remarks

Informs the application that a server is ready for a DDE connect. Return TRUE for a connect, otherwise return FALSE. On default this function returns allways TRUE, you must override this function to code the behaviour you want.

#### Init

#### Return-Value

BOOL success

#### Remarks

Initiates a connection from a client to a server.

#### Terminate

#### Remarks

Terminates the dde-connection

#### XDDE

#### Parameters

XWindow * owner | the window to handle dde for. If you have set a control as a client for a framewindow with SetClient() you must give the control as the owner of the XDDE instance, not the frame window!
char * appName | application name: server: the appname to distribute client: the needed appname
char * topicName | topic name: server: the topic to distribute client: the needed topic
BOOL isServer | TRUE = server is generated, FALSE = client is generated (default is FALSE). If a server is generated XDDE will handle all events automaticaly, for clients you must call XDDE::Init() to get a connection to a server

#### Remarks

Constructs a XDDE instance

#### ~XDDE

#### Remarks

The destructor of an instance is not called automaticaly, so donït forget to call this function. If a connection is established, XDDE::Terminate() is called automaticaly

#### Advise

#### Parameters

char * itemName the name of the requested item
SHORT format needed format of data

#### Remarks

Calls the server to establish a continous data-exchange

#### GetData

#### Parameters

char * itemName the name of the requested item
SHORT format needed format of data

#### Remarks

Calls the server send data one time

#### PokeData

#### Parameters

OOL_WINDOWHANDLE | handle of the receiver
char * itemName | the name of the requested item
void * data | buffer which holds data
ULONG size | size of the buffer
SHORT format | format of the data (default is DDEF_TEXT)

#### Remarks

Poke data

#### SendCommand

#### Parameters

char * itemName the name of the requested item
char * command command to execute

#### Remarks

Send a command

#### SendData

#### Parameters

OOL_WINDOWHANDLE | handle of the receiver
char * itemName | the name of the requested item
void * data | buffer which holds data
ULONG size | size of the buffer
SHORT format | format of the data (default is DDEF_TEXT)

#### Remarks

Send data to a client

#### UnAdvise

#### Parameters

char * itemName the name of the requested item

#### Return-Value

BOOL success

#### Remarks

Calls the server to stop continous data-exchange

#### IsConnected

#### Return-Value

BOOL connected

#### Remarks

Returns if a connection is established or not

#### QueryOwner

#### Return-Value

XWindow * the owner

#### Remarks

Returns a pointer to the owner window

This document was generated by Jens von Pilgrim's Autodoc