view docs/ccguide/defdrive.refentry @ 2168:fbfc56b826bf

Makin' changines
author boisy
date Sat, 24 May 2008 12:52:17 +0000
parents 1e1552ce8388
children
line wrap: on
line source

<refentry id="defdrive">
<refnamediv>
<refname>Defdrive</refname>
<refpurpose>get default system drive</refpurpose>
</refnamediv>

<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
  <funcdef>char *<function>defdrive</function></funcdef>
  <void/>
</funcprototype>
</funcsynopsis>

</refsynopsisdiv>

<refsect1><title>Description</title>
<para>
A call to defdrive returns a pointer to a string containing the
name of the default system drive. The method used is to
consult the "Init" module for the default directory name. The
name is copied to a static data area and a pointer to it is
returned.
</para>
</refsect1>

<refsect1><title>Diagnostics</title>
<para>
-1 is returned if the "Init" module cannot be linked to.
</para>
</refsect1>

</refentry>