123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 |
- <!-- $XConsortium: MmdbSsGN.sgm /main/5 1996/09/08 20:09:15 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.DtMmdbStylesheetGetName">]]><refmeta><refentrytitle>
- DtMmdbStylesheetGetName</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
- <refname><function>DtMmdbStylesheetGetName</function></refname><refpurpose>obtains
- the name of a stylesheet</refpurpose></refnamediv><refsynopsisdiv>
- <funcsynopsis>
- <funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
- <funcdef>const char* <function>DtMmdbStylesheetGetName</function></funcdef>
- <paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
- </funcsynopsis>
- </refsynopsisdiv><refsect1>
- <title>DESCRIPTION</title>
- <para>The <function>DtMmdbStylesheetGetName</function> function
- returns the name of the specified stylesheet object. Do not use the
- <function>free</function> function on the returned pointer.
- </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 stylesheet object's Database Engine identifier, in the
- <symbol role="Variable">primary_oid</symbol> field.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1><refsect1>
- <title>RETURN VALUE</title>
- <para>If <function>DtMmdbStylesheetGetName</function> completes
- successfully, it returns a pointer to a NULL-terminated
- name character string. If it fails, it returns a NULL pointer.
- </para>
- </refsect1><refsect1>
- <title>EXAMPLE</title>
- <para>The following shows how a <function>DtMmdbStylesheetGetName</function> call
- might be coded.</para>
- <informalexample>
- <programlisting>DtMmdbInfoRequest request;
- /* fill the request here */
- request.primary_oid = DtMmdbSectionGetStyleSheetId(&request);
- DtMmdbStylesheetGetName(&request);
- </programlisting>
- </informalexample>
- </refsect1><refsect1>
- <title>SEE ALSO</title>
- <para>TO BE SUPPLIED
- </para>
- </refsect1></refentry>
|