Share via


DDEClient Class

The DDEClient class is used to instantiate DDE (Dynamic Data Exchange) objects.

Syntax

class DDEClient extends Object

Run On

Client

Methods

  Method Description
Gg837485.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif execute Sends an execute transaction to the Dynamic Data Exchange (DDE) server.
Gg837485.pubmethod(en-us,AX.60).gif finalize Microsoft recommends that you not use the DDEClient class in any new development.
Gg837485.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif isValid The status of the Dynamic Data Exchange (DDE) conversation.
Gg837485.pubmethod(en-us,AX.60).gif new Initializes a new instance of the Object class. (Overrides the new Method.)
Gg837485.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif poke Sends unsolicited data to the server. This method is used by clients.
Gg837485.pubmethod(en-us,AX.60).gif request Requests the data that belongs to an item.
Gg837485.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg837485.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

DDE is a form of interprocess communication that is used to exchange data between applications. Microsoft Dynamics AX supports only text data format (CF_TEXT) and DDE one-time data transfers (Microsoft Dynamics AX does not support advise links).

By default, this class is turned off. For more information, see APIs Turned Off by Default. To grant access to this API, you must enable the Dynamic Data Exchange API configuration key (SysAPIDDE).

There is no need to derive new classes from this class. It is used as a DDE handler for various DDE transactions.

DDE transactions can be synchronous or asynchronous. During a synchronous transaction, the method does not return until the transaction either is completed successfully or fails. Synchronous transactions cause a client to enter a modal loop while it waits for various asynchronous events. Therefore, a client application can still respond to user input while it waits for a synchronous transaction, but the application cannot begin a second synchronous transaction because of the activity that is associated with the first.

During an asynchronous transaction, the method returns after the transaction has begun. It is not possible to abort or get the result of an asynchronous transaction.

Inheritance Hierarchy

Object Class
  DDEClient Class