sdk/2.0/docs/man/write_pipe.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd" [
<!ENTITY pipeFunctionsInc SYSTEM "pipeFunctionsInc.xml">
]>

<refentry>
    <refentryinfo>
        <keywordset>
            <keyword>write_pipe</keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>
        <refentrytitle>write_pipe</refentrytitle>

        <refmiscinfo>
            <copyright>
                <year>2007-2013</year>
                <holder>The Khronos Group Inc.
 Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.</holder>
            </copyright>
        </refmiscinfo>
        <manvolnum>3</manvolnum>
    </refmeta>

<!-- ================================ SYNOPSIS -->

    <refnamediv id="write_pipe">
        <refname>write_pipe</refname>

        <refpurpose>
            Read packet from <varname>pipe</varname> into <varname>ptr</varname>.
        </refpurpose>
    </refnamediv>

    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>
                    <link xlink:href="scalarDataTypes.html">int</link>
                    <function>
                        write_pipe
                    </function>
                </funcdef>
                <paramdef>pipe gentype <parameter>p</parameter></paramdef>
                <paramdef>const gentype <parameter>*ptr</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>

        <funcsynopsis>
            <funcprototype>
                <funcdef>
                    <link xlink:href="scalarDataTypes.html">int</link>
                    <function>
                        write_pipe
                    </function>
                </funcdef>
                <paramdef>pipe gentype <parameter>p</parameter></paramdef>
                <paramdef><link xlink:href="enums.html#reserve_id_t">reserve_id_t</link><parameter>reserve_id</parameter></paramdef>
                <paramdef><link xlink:href="scalarDataTypes.html">uint</link><parameter>index</parameter></paramdef>
                <paramdef>const gentype <parameter>*ptr</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>

    </refsynopsisdiv>

<!-- ================================ DESCRIPTION  -->

    <refsect1 id="description"><title>Description</title>
        <para>
            For the form without <varname>reserve_id</varname>,
            write packet specified by <varname>ptr</varname> 
            into pipe <varname>p</varname>. Returns 0 if 
            <function>write_pipe</function> is successful and a negative value if the 
            pipe is full.
        </para>

        <para>
            For the form using <varname>reserve_id</varname>,
            write packet specified by <varname>ptr</varname> to the reserved area of 
            the pipe referred to by <varname>reserve_id</varname> and <varname>index</varname>.
            The reserved pipe entries are referred to by indices 
            that go from 0 … <varname>num_packets</varname> – 1.
            Returns 0 if <function>write_pipe</function> is successful and a negative 
            value otherwise.
        </para>

        &pipeFunctionsInc;

    </refsect1>

<!-- ================================ NOTES
    <refsect1 id="notes"><title>Notes</title>
        <para>

        </para>
    </refsect1> -->
<!-- ================================ EXAMPLE  -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
<!--
    <refsect2 id="example1">
        <title>
            Example
        </title>

        <informaltable frame="none">
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
                <colspec colname="col1" colnum="1" />
                <tbody>
                    <row>
                        <entry>
                            Example goes here - it will be set in "code" type with white space preserved.
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect2>
-->

<!-- ================================ SPECIFICATION  -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
    <refsect1 id="specification"><title>Specification</title>
        <para>
            <imageobject>
                <imagedata fileref="pdficon_small1.gif" format="gif" />
            </imageobject>

            <olink uri="write_pipe">OpenCL Specification</olink>
        </para>
    </refsect1>

<!-- ================================ ALSO SEE  -->
    <refsect1 id="seealso"><title>Also see</title>
        <para>
            <citerefentry href="pipeFunctions"><refentrytitle>Pipe Functions</refentrytitle></citerefentry>
        </para>
    </refsect1>

<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->

    <refsect3 id="Copyright"><title></title>
        <imageobject>
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
        </imageobject>
        <para />
    </refsect3>

<!-- 20-Dec-2013, rev. 19 -->
</refentry>