← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/windows_tools/help/en_US/mcisendstring.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/windows_tools/help/en_US/mcisendstring.xml
11
11
 *
12
12
 -->
13
13
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="mcisendstring">
14
 
  <refnamediv>
15
 
    <refname>mcisendstring</refname>
16
 
    <refpurpose>sends a command string to an MCI
17
 
      device (Windows only)
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>mcisendstring(mcistring)
23
 
      bOK=mcisendstring(mcistring)
24
 
      [bOK,CodeError]=mcisendstring(mcistring)
25
 
      [bOK,CodeError,StringError]=mcisendstring(mcistring)
26
 
    </synopsis>
27
 
  </refsynopsisdiv>
28
 
  <refsection>
29
 
    <title>Arguments</title>
30
 
    <variablelist>
31
 
      <varlistentry>
32
 
        <term>mcistring</term>
33
 
        <listitem>
34
 
          <para>a command string to send to an MCI device</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>bOK</term>
39
 
        <listitem>
40
 
          <para>returns %T or %F</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>CodeError</term>
45
 
        <listitem>
46
 
          <para>returns error code (0 --&gt; if bOK == %T)</para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
      <varlistentry>
50
 
        <term>StringError</term>
51
 
        <listitem>
52
 
          <para>returns MCI interpreter message ('OK' --&gt; if bOK ==
53
 
            %T)
54
 
          </para>
55
 
        </listitem>
56
 
      </varlistentry>
57
 
    </variablelist>
58
 
  </refsection>
59
 
  <refsection>
60
 
    <title>Description</title>
61
 
    <para>The mciSendString primitive sends a command string to an MCI device.
62
 
      The device that the command is sent to is specified in the command
63
 
      string.
64
 
    </para>
65
 
    <para>
66
 
      see on <ulink url="http://msdn.microsoft.com/library/default.asp">http://msdn.microsoft.com/library/default.asp</ulink> and search
67
 
      "Windows Multimedia SDK open"
68
 
    </para>
69
 
  </refsection>
70
 
  <refsection>
71
 
    <title>Examples</title>
72
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>mcisendstring</refname>
 
16
        <refpurpose>sends a command string to an MCI
 
17
            device (Windows only)
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>mcisendstring(mcistring)
 
23
            bOK=mcisendstring(mcistring)
 
24
            [bOK,CodeError]=mcisendstring(mcistring)
 
25
            [bOK,CodeError,StringError]=mcisendstring(mcistring)
 
26
        </synopsis>
 
27
    </refsynopsisdiv>
 
28
    <refsection>
 
29
        <title>Arguments</title>
 
30
        <variablelist>
 
31
            <varlistentry>
 
32
                <term>mcistring</term>
 
33
                <listitem>
 
34
                    <para>a command string to send to an MCI device</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
            <varlistentry>
 
38
                <term>bOK</term>
 
39
                <listitem>
 
40
                    <para>returns %T or %F</para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>CodeError</term>
 
45
                <listitem>
 
46
                    <para>returns error code (0 --&gt; if bOK == %T)</para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
            <varlistentry>
 
50
                <term>StringError</term>
 
51
                <listitem>
 
52
                    <para>returns MCI interpreter message ('OK' --&gt; if bOK ==
 
53
                        %T)
 
54
                    </para>
 
55
                </listitem>
 
56
            </varlistentry>
 
57
        </variablelist>
 
58
    </refsection>
 
59
    <refsection>
 
60
        <title>Description</title>
 
61
        <para>The mciSendString primitive sends a command string to an MCI device.
 
62
            The device that the command is sent to is specified in the command
 
63
            string.
 
64
        </para>
 
65
        <para>
 
66
            see on <ulink url="http://msdn.microsoft.com/library/default.asp">http://msdn.microsoft.com/library/default.asp</ulink> and search
 
67
            "Windows Multimedia SDK open"
 
68
        </para>
 
69
    </refsection>
 
70
    <refsection>
 
71
        <title>Examples</title>
 
72
        <programlisting role="example"><![CDATA[ 
73
73
mcisendstring("open ""d:\audio.mp3"" type MPEGVideo alias MP3_Device") 
74
74
mcisendstring("play MP3_Device") 
75
75
mcisendstring("close MP3_Device") 
78
78
mcisendstring("play AVI_Device from 0") 
79
79
mcisendstring("close AVI_Device") 
80
80
 ]]></programlisting>
81
 
  </refsection>
 
81
    </refsection>
82
82
</refentry>