newlib-cygwin/winsup/doc/misc-funcs.xml

<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
    "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

<sect1 id="func-cygwin-misc">
<title>Miscellaneous functions</title>

<refentry id="func-cygwin-attach-handle-to-fd">
  <refmeta>
    <refentrytitle>cygwin_attach_handle_to_fd</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo class="manual">Cygwin API Reference</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>cygwin_attach_handle_to_fd</refname>
  </refnamediv>

  <refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
#include &lt;sys/cygwin.h&gt;
</funcsynopsisinfo>
<funcprototype>
<funcdef>int
<function>cygwin_attach_handle_to_fd</function></funcdef>
<paramdef>char *<parameter>name</parameter></paramdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>HANDLE <parameter>handle</parameter></paramdef>
<paramdef>int <parameter>bin</parameter></paramdef>
<paramdef>int <parameter>access</parameter></paramdef>
</funcprototype></funcsynopsis>
  </refsynopsisdiv>

  <refsect1 id="func-cygwin-attach-handle-to-fd-desc">
    <title>Description</title>
<para>This function can be used to turn a Win32 "handle" into a
posix-style file handle. <parameter>fd</parameter> may be -1 to
make cygwin allocate a handle; the actual handle is returned
in all cases.</para>

<para>Even after using function, Cygwin doesn't know anything about the
underlying file or device.  It just tries to supply the typical file
functions on a "best-effort" basis.  Use with care.  Don't expect too
much.</para>
  </refsect1>
</refentry>

<refentry id="func-cygwin-internal">
  <refmeta>
    <refentrytitle>cygwin_internal</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo class="manual">Cygwin API Reference</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>cygwin_internal</refname>
  </refnamediv>

  <refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
#include &lt;sys/cygwin.h&gt;
</funcsynopsisinfo>
<funcprototype>
<funcdef>uintptr_t
<function>cygwin_internal</function></funcdef>
<paramdef>cygwin_getinfo_types <parameter>t</parameter></paramdef>
<paramdef><parameter>...</parameter></paramdef>
</funcprototype></funcsynopsis>
  </refsynopsisdiv>

  <refsect1 id="func-cygwin-internal-desc">
    <title>Description</title>
<para>This function gives you access to various internal data and functions.
It takes two arguments.  The first argument is a type from the 'cygwin_getinfo_types'
enum.  The second is an optional pointer.</para>
<para>Stay away unless you know what you're doing.</para>
  </refsect1>
</refentry>


<refentry id="func-cygwin-stackdump">
  <refmeta>
    <refentrytitle>cygwin_stackdump</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo class="manual">Cygwin API Reference</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>cygwin_stackdump</refname>
  </refnamediv>

  <refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
#include &lt;sys/cygwin.h&gt;
</funcsynopsisinfo>
<funcprototype>
<funcdef>void
<function>cygwin_stackdump</function></funcdef>
<void />
</funcprototype></funcsynopsis>
  </refsynopsisdiv>

  <refsect1 id="func-cygwin-stackdump-desc">
    <title>Description</title>
<para> Outputs a stackdump to stderr from the called location.
</para>
<para> Note: This function only has an effect the first time it is called by a process.
</para>
<para> Note: This function is deprecated.
</para>
  </refsect1>
</refentry>

</sect1>