73 lines
2.8 KiB
Plaintext
73 lines
2.8 KiB
Plaintext
<!-- $XConsortium: MmdbSeGL.sgm /main/5 1996/09/08 20:08:59 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.DtMmdbSectionGetLoc">]]><refmeta><refentrytitle>
|
|
DtMmdbSectionGetLoc</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
|
<refname><function>DtMmdbSectionGetLoc</function></refname><refpurpose>obtains
|
|
a section's locator</refpurpose></refnamediv><refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
|
<funcdef>const char* <function>DtMmdbSectionGetLoc</function></funcdef>
|
|
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <function>DtMmdbSectionGetLoc</function> function
|
|
returns the logical identifier for the specified section. Do not use the
|
|
<function>free</function> function on the returned pointer. No table lookup is
|
|
involved.
|
|
</para>
|
|
<para>The space used by the returned locator pointer is likely to be
|
|
reused by the database engine when any of the API functions
|
|
are invoked again. You must make a copy of the content
|
|
if you want to retain it across multiple API calls.
|
|
This behavior holds true for all functions that return
|
|
a <literal>const char*</literal> 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 section's Database Engine (object) identifier in the
|
|
<symbol role="Variable">primary_oid</symbol> field.
|
|
The DtInfo Database Engine identifier is assigned to
|
|
the section when it is stored.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1><refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para>If <function>DtMmdbSectionGetLoc</function> completes
|
|
successfully, it returns a pointer to a NULL-terminated
|
|
locator string. If it fails, it returns a NULL pointer.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>EXAMPLE</title>
|
|
<para>The following shows how a <function>DtMmdbSectionGetLoc</function> call
|
|
might be coded.</para>
|
|
<informalexample>
|
|
<programlisting>const char* locator = 0;
|
|
DtMmdbInfoRequest request;
|
|
int bd = DtMmdbGetBookCase(myInfoLibPtr, "myBase");
|
|
if ( bd >= 0) {
|
|
request.bookcase_descriptor = bd;
|
|
request.sequence_num = 1;
|
|
request.primary_oid = DtMmdbBookGetTocObjectId(&request);
|
|
locator = DtMmdbSectionGetLoc(&request);
|
|
}
|
|
</programlisting>
|
|
</informalexample>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>TO BE SUPPLIED
|
|
</para>
|
|
</refsect1></refentry>
|