61 lines
2.4 KiB
Plaintext
61 lines
2.4 KiB
Plaintext
<!-- $XConsortium: MmdbGrGI.sgm /main/7 1996/09/08 20:07:07 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.DtMmdbGraphicGetInfo">]]><refmeta><refentrytitle>
|
|
DtMmdbGraphicGetInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
|
<refname><function>DtMmdbGraphicGetInfo</function></refname><refpurpose>obtains
|
|
information about a graphic object</refpurpose></refnamediv><refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
|
<funcdef>DtMmdbGraphicInfo* <function>DtMmdbGraphicGetInfo</function></funcdef>
|
|
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <function>DtMmdbGraphicGetInfo</function> function
|
|
returns a structure containing the information about
|
|
a graphic object. Use the
|
|
<function>DtMmdbFreeGraphicInfo</function> function to release
|
|
the memory when the structure is no longer needed. 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>
|
|
</variablelist>
|
|
</refsect1><refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para>If <function>DtMmdbGraphicGetInfo</function> completes
|
|
successfully, it returns a pointer to the graphic
|
|
information structure.
|
|
If it fails, it returns a NULL pointer.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>EXAMPLE</title>
|
|
<para>The following shows how a <function>DtMmdbGraphicGetInfo</function> call
|
|
might be coded.</para>
|
|
<informalexample>
|
|
<programlisting>DtMmdbInfoRequest request;
|
|
/* fill the request */
|
|
DtMmdbGraphicGetInfo(&request);
|
|
</programlisting>
|
|
</informalexample>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>&cdeman.DtMmdbFreeGraphicInfo;</para>
|
|
</refsect1></refentry>
|