MmdbSsGN.sgm 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. <!-- $XConsortium: MmdbSsGN.sgm /main/5 1996/09/08 20:09:15 rws $ -->
  2. <!-- (c) Copyright 1996 Digital Equipment Corporation. -->
  3. <!-- (c) Copyright 1996 Hewlett-Packard Company. -->
  4. <!-- (c) Copyright 1996 International Business Machines Corp. -->
  5. <!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
  6. <!-- (c) Copyright 1996 Novell, Inc. -->
  7. <!-- (c) Copyright 1996 FUJITSU LIMITED. -->
  8. <!-- (c) Copyright 1996 Hitachi. -->
  9. <![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbStylesheetGetName">]]><refmeta><refentrytitle>
  10. DtMmdbStylesheetGetName</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
  11. <refname><function>DtMmdbStylesheetGetName</function></refname><refpurpose>obtains
  12. the name of a stylesheet</refpurpose></refnamediv><refsynopsisdiv>
  13. <funcsynopsis>
  14. <funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
  15. <funcdef>const char* <function>DtMmdbStylesheetGetName</function></funcdef>
  16. <paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
  17. </funcsynopsis>
  18. </refsynopsisdiv><refsect1>
  19. <title>DESCRIPTION</title>
  20. <para>The <function>DtMmdbStylesheetGetName</function> function
  21. returns the name of the specified stylesheet object. Do not use the
  22. <function>free</function> function on the returned pointer.
  23. </para>
  24. </refsect1><refsect1>
  25. <title>ARGUMENTS</title>
  26. <variablelist>
  27. <varlistentry><term><symbol role="Variable">request</symbol></term>
  28. <listitem>
  29. <para>Specifies the bookcase in the bookcase descriptor field and
  30. the stylesheet object's Database Engine identifier, in the
  31. <symbol role="Variable">primary_oid</symbol> field.
  32. </para>
  33. </listitem>
  34. </varlistentry>
  35. </variablelist>
  36. </refsect1><refsect1>
  37. <title>RETURN VALUE</title>
  38. <para>If <function>DtMmdbStylesheetGetName</function> completes
  39. successfully, it returns a pointer to a NULL-terminated
  40. name character string. If it fails, it returns a NULL pointer.
  41. </para>
  42. </refsect1><refsect1>
  43. <title>EXAMPLE</title>
  44. <para>The following shows how a <function>DtMmdbStylesheetGetName</function> call
  45. might be coded.</para>
  46. <informalexample>
  47. <programlisting>DtMmdbInfoRequest request;
  48. /* fill the request here */
  49. request.primary_oid = DtMmdbSectionGetStyleSheetId(&amp;request);
  50. DtMmdbStylesheetGetName(&amp;request);
  51. </programlisting>
  52. </informalexample>
  53. </refsect1><refsect1>
  54. <title>SEE ALSO</title>
  55. <para>TO BE SUPPLIED
  56. </para>
  57. </refsect1></refentry>