a0526f44fd17d1e9b31d7e47f209def3043c58c4
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2bmp.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
3 <MAN>
4   <LANGUAGE>eng</LANGUAGE>
5
6   <TITLE>xs2bmp</TITLE>
7
8   <TYPE>Scilab Function</TYPE>
9
10   <DATE>$LastChangedDate: 2006-08-03 16:16:36 +0200 (jeu., 03 août 2006) $</DATE>
11
12   <SHORT_DESCRIPTION name="xs2bmp">send graphics to a file in BMP syntax (Only
13   for Windows)</SHORT_DESCRIPTION>
14
15   <CALLING_SEQUENCE>
16     <CALLING_SEQUENCE_ITEM>xs2bmp(win_num,filen)</CALLING_SEQUENCE_ITEM>
17   </CALLING_SEQUENCE>
18
19   <PARAM>
20     <PARAM_INDENT>
21       <PARAM_ITEM>
22         <PARAM_NAME>win_num</PARAM_NAME>
23
24         <PARAM_DESCRIPTION>
25           <SP>: integer scalar.</SP>
26         </PARAM_DESCRIPTION>
27       </PARAM_ITEM>
28
29       <PARAM_ITEM>
30         <PARAM_NAME>filen</PARAM_NAME>
31
32         <PARAM_DESCRIPTION>
33           <SP>: string, file name.</SP>
34         </PARAM_DESCRIPTION>
35       </PARAM_ITEM>
36     </PARAM_INDENT>
37   </PARAM>
38
39   <DESCRIPTION>
40     <P><VERB>xs2bmp</VERB> sends the recorded graphics of the window
41     <VERB>win_num</VERB> in the file <VERB>filen</VERB> in BMP format. This
42     function works only if the selected driver is <VERB>"Rec"</VERB> in the
43     window <VERB>win_num</VERB> or if the window is in "new style".</P>
44   </DESCRIPTION>
45
46   <EXAMPLE><![CDATA[ 
47     //simple example
48     scf(0)
49     plot2d()
50     xs2bmp(0,'foo.bmp')
51   ]]></EXAMPLE>
52
53   <SEE_ALSO>
54     <SEE_ALSO_ITEM>
55       <LINK>xs2gif</LINK>
56         </SEE_ALSO_ITEM>
57         
58         <SEE_ALSO_ITEM>
59       <LINK>xs2jpg</LINK>
60         </SEE_ALSO_ITEM>
61         
62         <SEE_ALSO_ITEM>
63       <LINK>xs2png</LINK>
64         </SEE_ALSO_ITEM>
65         
66         <SEE_ALSO_ITEM>
67       <LINK>xs2ppm</LINK>
68     </SEE_ALSO_ITEM>
69         
70         <SEE_ALSO_ITEM>
71       <LINK>xs2eps</LINK>
72     </SEE_ALSO_ITEM>
73         
74         <SEE_ALSO_ITEM>
75       <LINK>xs2pdf</LINK>
76     </SEE_ALSO_ITEM>
77         
78         <SEE_ALSO_ITEM>
79       <LINK>xs2svg</LINK>
80     </SEE_ALSO_ITEM>
81         
82         <SEE_ALSO_ITEM>
83       <LINK>xs2ps</LINK>
84     </SEE_ALSO_ITEM>
85   
86     <SEE_ALSO_ITEM>
87       <LINK>xs2fig</LINK>
88     </SEE_ALSO_ITEM>    
89
90     <SEE_ALSO_ITEM>
91       <LINK>xs2emf</LINK>
92     </SEE_ALSO_ITEM>
93   </SEE_ALSO>
94
95   <AUTHOR>A.C</AUTHOR>
96 </MAN>