1<?xml version="1.0" encoding="UTF-8"?>
2
3
4<!--***********************************************************
5 *
6 * Licensed to the Apache Software Foundation (ASF) under one
7 * or more contributor license agreements.  See the NOTICE file
8 * distributed with this work for additional information
9 * regarding copyright ownership.  The ASF licenses this file
10 * to you under the Apache License, Version 2.0 (the
11 * "License"); you may not use this file except in compliance
12 * with the License.  You may obtain a copy of the License at
13 *
14 *   http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing,
17 * software distributed under the License is distributed on an
18 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19 * KIND, either express or implied.  See the License for the
20 * specific language governing permissions and limitations
21 * under the License.
22 *
23 ***********************************************************-->
24
25
26
27<helpdocument version="1.0">
28<meta>
29<topic id="textsbasicshared03010303xml" indexer="include" status="PUBLISH">
30<title id="tit" xml-lang="en-US">Red Function [Runtime]</title>
31<filename>/text/sbasic/shared/03010303.xhp</filename>
32</topic>
33<history>
34<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
35<lastedited date="2004-09-01T15:12:52">converted from old format - fpe</lastedited>
36</history>
37</meta>
38<body>
39<section id="red">
40<bookmark xml-lang="en-US" branch="index" id="bm_id3148947"><bookmark_value>Red function</bookmark_value>
41</bookmark>
42<paragraph role="heading" id="hd_id3148947" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03010303.xhp" name="Red Function [Runtime]">Red Function [Runtime]</link></paragraph>
43<paragraph role="paragraph" id="par_id3149656" xml-lang="en-US" l10n="U" oldref="2">Returns the Red component of the specified color code.</paragraph>
44</section>
45<paragraph role="heading" id="hd_id3148799" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
46<paragraph role="code" id="par_id3150448" xml-lang="en-US" l10n="U" oldref="4">Red (ColorNumber As Long)</paragraph>
47<paragraph role="heading" id="hd_id3151042" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
48<paragraph role="paragraph" id="par_id3145173" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
49<paragraph role="heading" id="hd_id3154685" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameter:</paragraph>
50<paragraph role="paragraph" id="par_id3150440" xml-lang="en-US" l10n="U" oldref="8">
51<emph>ColorNumber</emph>: Long integer expression that specifies any <link href="text/sbasic/shared/00000003.xhp#farbcodes" name="color code">color code</link> for which to return the Red component.</paragraph>
52<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
53<embed href="text/sbasic/shared/00000003.xhp#err5"/>
54<paragraph role="heading" id="hd_id3148575" xml-lang="en-US" level="2" l10n="U" oldref="9">Example:</paragraph>
55<paragraph role="code" id="par_id3145365" xml-lang="en-US" l10n="U" oldref="10">Sub ExampleColor</paragraph>
56<paragraph role="code" id="par_id3147348" xml-lang="en-US" l10n="U" oldref="11">Dim lVar As Long</paragraph>
57<paragraph role="code" id="par_id3145750" xml-lang="en-US" l10n="U" oldref="12">lVar = rgb(128,0,200)</paragraph>
58<paragraph role="code" id="par_id3147435" xml-lang="en-US" l10n="U" oldref="13">msgbox "The color " &amp; lVar &amp; " consists of:" &amp; Chr(13) &amp;_</paragraph>
59<paragraph role="code" id="par_id3155306" xml-lang="en-US" l10n="U" oldref="14">"red= " &amp; red(lVar) &amp; Chr(13)&amp;_</paragraph>
60<paragraph role="code" id="par_id3149262" xml-lang="en-US" l10n="U" oldref="15">"green= " &amp; green(lVar) &amp; Chr(13)&amp;_</paragraph>
61<paragraph role="code" id="par_id3147397" xml-lang="en-US" l10n="U" oldref="16">"blue= " &amp; blue(lVar) &amp; Chr(13) , 64,"colors"</paragraph>
62<paragraph role="code" id="par_id3156286" xml-lang="en-US" l10n="U" oldref="17">end sub</paragraph>
63</body>
64</helpdocument>
65