67 lines
2.6 KiB
Plaintext
67 lines
2.6 KiB
Plaintext
<!-- $XConsortium: MmdbGrGD.sgm /main/5 1996/09/08 20:06:58 rws $ -->
|
|
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
|
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
|
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
|
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
|
<!-- (c) Copyright 1996 Novell, Inc. -->
|
|
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
|
<!-- (c) Copyright 1996 Hitachi. -->
|
|
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbGraphicGetData">]]><refmeta><refentrytitle>
|
|
DtMmdbGraphicGetData</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
|
<refname><function>DtMmdbGraphicGetData</function></refname><refpurpose>obtains
|
|
the data for a graphic object</refpurpose></refnamediv><refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
|
<funcdef>const char* <function>DtMmdbGraphicGetData</function></funcdef>
|
|
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
|
<paramdef>unsigned int* <parameter>length</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <function>DtMmdbGraphicGetData</function> function
|
|
returns the data for a graphic object. Do not use the
|
|
<function>free</function> function on the returned pointer. Table lookup is involved
|
|
because the graphic identifier is specified by the
|
|
<symbol role="Variable">locator_ptr</symbol> field.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>ARGUMENTS</title>
|
|
<variablelist>
|
|
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the bookcase in the bookcase descriptor field and the
|
|
identifier of the graphic object in the
|
|
<symbol role="Variable">locator_ptr</symbol> field.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><symbol role="Variable">length</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the variable to receive the length of the
|
|
returned data, if the returned pointer to the title is not NULL.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1><refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para>If <function>DtMmdbGraphicGetData</function> completes
|
|
successfully, it returns a pointer to the data for
|
|
the graphic object.
|
|
If it fails, it returns a NULL pointer.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>EXAMPLE</title>
|
|
<para>The following shows how a <function>DtMmdbGraphicGetData</function> call
|
|
might be coded.</para>
|
|
<informalexample>
|
|
<programlisting>DtMmdbInfoRequest request;
|
|
/* fill the request */
|
|
DtMmdbGraphicGetData(&request);
|
|
</programlisting>
|
|
</informalexample>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>TO BE SUPPLIED</para>
|
|
</refsect1></refentry>
|