Syntax 3: For data in an OLE server
Description
Gets data from the OLE server associated with an OLE control using
Uniform Data Transfer.
Applies to
OLE controls and OLE custom controls
Syntax
|
1 |
olename.GetData ( clipboardformat, data ) |
|
Argument |
Description |
|---|---|
|
olename |
The name of the OLE or custom control containing the |
|
clipboardformat |
The format for the data. You can specify a standard Values for clipboardformat are: ClipFormatBitmap! ClipFormatDIB! ClipFormatDIF! ClipFormatEnhMetafile! ClipFormatHdrop! ClipFormatLocale! ClipFormatMetafilePict! ClipFormatOEMText! ClipFormatPalette! ClipFormatPenData! ClipFormatRIFF! ClipFormatSYLK! ClipFormatText! ClipFormatTIFF! ClipFormatUnicodeText! ClipFormatWave! If clipboardformat is an empty string or a null value, |
|
data |
A string or blob variable that will contain the data |
Return value
Integer.
Returns 0 if it succeeds and -1 if an error occurs.
Usage
GetData will return an error if you specify a clipboard format
that the OLE server does not support. To find out what formats it
supports, see the documentation for the OLE server.
GetData operates via Uniform Data Transfer, a mechanism defined by
Microsoft for exchanging data with container applications. PowerBuilder
enables data transfer via a global handle. The OLE server must also
support data transfer via a global handle. If it does not, you cannot
transfer data to or from that server.
Examples
After the user has activated a Microsoft Word document and edited
its contents, this example gets the contents from the OLE control
ole_word6 and stores the contents in the string ls_oledata. The contents
of the string are then displayed in the MultiLineEdit mle_text:
|
1 2 3 4 5 6 |
string ls_oledata integer li_rtn li_rtn = ole_word6.GetData( & ClipFormatText!, ls_oledata) mle_text.Text = ls_oledata |
One OLE control displays a Microsoft Word document containing a
table of data. This example gets the data in the report and assigns it
to a graph in a second OLE control. Microsoft Graph in the second
control interprets the first row in the table as headings, and
subsequent rows as categories or series, depending on the settings on
the Data menu:
|
1 2 3 4 5 6 7 |
string ls_data integer li_rtn li_rtn = ole_word.GetData(ClipFormatText!, ls_data) IF li_rtn <> 1 THEN RETURN li_rtn = ole_graph.SetData(ClipFormatText!, ls_data) |
See also