Please enable JavaScript to view this site.

ESL Documentation

Function

Return the format name associated with a specified conversation.

 

DDEGetFormat ( ConvID_IV )

 

ConvID_IV is an integer value representing the conversation ID assigned by the DDE DLL.

Description

Called by client or server. This function returns a string that is the format name associated with the current event for the conversation specified by the ConvID_IV argument.

Call this function only in response to the following events to determine if the format is one that the application can handle, or to determine how to interpret the data:

 

DDE_REQUEST

DDE_DATA

DDE_ADVISE

DDE_UNADVISE

DDE_POKE

DDE_ACK

DDE_NACK

 

DDE pre-defines a text format, represented by the constant DDEFMT_TEXT, which is defined in ESLDDE.INC as the string "#1". Use this constant when testing the return value of DDEGetFormat in your application to determine if the data is in plain text format, since many other applications may request other formats before accepting plain text format.

Example

response to stimulus DDE DDE_ADVISE

copy eventparam to ConvID_IV

copy DDEGetFormat (ConvID_IV) to Format_SV

if (Format_SV = DDEFMT_TEXT) then

    # Plain text format

    # Accept the advise state

else

    # Reject this advise

end if