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