Top
PowerCOBOL V11.0 Reference
FUJITSU Software

5.46 GetHotData Method

Description:

Acquires data from the DDE server when a DDECHANGE event is generated by the hot link.

The maximum length that can be acquired at a time is 1024 bytes. When you need to acquire data of 1024 bytes or more, you get it in 1024 byte chunks.

Used in controls:

DDE

Used in objects:

None.

Parameters:

No OLE data types.

HotData: A group item whose length is 1028 bytes.

Description of Parameters:

HotData has the following elementary items:

DataLengthS9(9) COMP-5
The length of the data in the buffer. If the total data length is longer than a single buffer can contain, use the DDEDataOffset property to track the data over multiple calls.

DataAreaX(1024)
The data from the DDE server

Return value:

VT_I4 - ReturnValue S9(9) COMP-5

Zero or greater indicates normal completion.
Negative indicates an error.

Example:

WORKING-STORAGE SECTION.
01 Hot-Data.
 03 Buffer-Length PIC S9(9) COMP-5. 
 03 Hot-Buffer    PIC X(1024) 
                      VALUE Spaces.
01 ReturnValue    PIC S9(9) COMP-5.
PROCEDURE DIVISION.
    COMPUTE Buffer-Length 
          = LENGTH OF Hot-Buffer 
    INVOKE CmDDE1 "GetHotData" 
      USING     Hot-Data 
      RETURNING ReturnValue

Backward compatibility
method name:

GETHOTDATA

Backward compatibility
arguments:

A group item made up of the following elementary items.

1.S9(9) COMP-5
2.X(1024)