helpcontent2/source/text/sbasic/shared/03080701.xhp

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3
   4 <!--***********************************************************************
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * Copyright 2008 by Sun Microsystems, Inc.
   9  *
  10  * OpenOffice.org - a multi-platform office productivity suite
  11  *
  12  * $RCSfile: 03080701.xhp,v $
  13  * $Revision: 1.5 $
  14  *
  15  * This file is part of OpenOffice.org.
  16  *
  17  * OpenOffice.org is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU Lesser General Public License version 3
  19  * only, as published by the Free Software Foundation.
  20  *
  21  * OpenOffice.org is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU Lesser General Public License version 3 for more details
  25  * (a copy is included in the LICENSE file that accompanied this code).
  26  *
  27  * You should have received a copy of the GNU Lesser General Public License
  28  * version 3 along with OpenOffice.org.  If not, see
  29  * <http://www.openoffice.org/license.html>
  30  * for a copy of the LGPLv3 License.
  31  *
  32  ************************************************************************-->
  33
  34 <helpdocument version="1.0">
  35 <meta>
  36 <topic id="textsbasicshared03080701xml" indexer="include" status="PUBLISH">
  37 <title id="tit" xml-lang="en-US">Sgn Function [Runtime]</title>
  38 <filename>/text/sbasic/shared/03080701.xhp</filename>
  39 </topic>
  40 <history>
  41 <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
  42 <lastedited date="2004-08-24T14:24:24">converted from old format - fpe</lastedited>
  43 </history>
  44 </meta>
  45 <body>
  46 <section id="sgn">
  47 <bookmark xml-lang="en-US" branch="index" id="bm_id3148474"><bookmark_value>Sgn function</bookmark_value>
  48 </bookmark>
  49 <paragraph role="heading" id="hd_id3148474" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03080701.xhp" name="Sgn Function [Runtime]">Sgn Function [Runtime]</link></paragraph>
  50 <paragraph role="paragraph" id="par_id3148686" xml-lang="en-US" l10n="U" oldref="2">Returns an integer number between -1 and 1 that indicates if the number that is passed to the function is positive, negative, or zero.</paragraph>
  51 </section>
  52 <paragraph role="heading" id="hd_id3156023" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
  53 <paragraph role="paragraph" id="par_id3153897" xml-lang="en-US" l10n="U" oldref="4">Sgn (Number)</paragraph>
  54 <paragraph role="heading" id="hd_id3145069" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
  55 <paragraph role="paragraph" id="par_id3150359" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
  56 <paragraph role="heading" id="hd_id3150543" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph>
  57 <paragraph role="paragraph" id="par_id3154365" xml-lang="en-US" l10n="U" oldref="8">
  58 <emph>Number:</emph> Numeric expression that determines the value that is returned by the function.</paragraph>
  59 <table id="tbl_id3156281">
  60 <tablerow>
  61 <tablecell colspan="" rowspan="">
  62 <paragraph role="paragraph" id="par_id3150767" xml-lang="en-US" l10n="U" oldref="9">NumExpression</paragraph>
  63 </tablecell>
  64 <tablecell colspan="" rowspan="">
  65 <paragraph role="paragraph" id="par_id3150441" xml-lang="en-US" l10n="U" oldref="10">Return value</paragraph>
  66 </tablecell>
  67 </tablerow>
  68 <tablerow>
  69 <tablecell colspan="" rowspan="">
  70 <paragraph role="paragraph" id="par_id3161833" xml-lang="en-US" l10n="U" oldref="11">negative</paragraph>
  71 </tablecell>
  72 <tablecell colspan="" rowspan="">
  73 <paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U" oldref="12">Sgn returns -1.</paragraph>
  74 </tablecell>
  75 </tablerow>
  76 <tablerow>
  77 <tablecell colspan="" rowspan="">
  78 <paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="13">0</paragraph>
  79 </tablecell>
  80 <tablecell colspan="" rowspan="">
  81 <paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U" oldref="14">Sgn returns 0.</paragraph>
  82 </tablecell>
  83 </tablerow>
  84 <tablerow>
  85 <tablecell colspan="" rowspan="">
  86 <paragraph role="paragraph" id="par_id3153139" xml-lang="en-US" l10n="U" oldref="15">positive</paragraph>
  87 </tablecell>
  88 <tablecell colspan="" rowspan="">
  89 <paragraph role="paragraph" id="par_id3154319" xml-lang="en-US" l10n="U" oldref="16">Sgn returns 1.</paragraph>
  90 </tablecell>
  91 </tablerow>
  92 </table>
  93 <embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
  94 <embed href="text/sbasic/shared/00000003.xhp#err5"/>
  95 <paragraph role="heading" id="hd_id3152576" xml-lang="en-US" level="2" l10n="U" oldref="17">Example:</paragraph>
  96 <paragraph role="paragraph" id="par_id3154791" xml-lang="en-US" l10n="U" oldref="18">Sub ExampleSgn</paragraph>
  97 <paragraph role="paragraph" id="par_id3155416" xml-lang="en-US" l10n="U" oldref="19">Print sgn(-10) REM returns -1</paragraph>
  98 <paragraph role="paragraph" id="par_id3154096" xml-lang="en-US" l10n="U" oldref="20">Print sgn(0) REM returns 0</paragraph>
  99 <paragraph role="paragraph" id="par_id3148457" xml-lang="en-US" l10n="U" oldref="21">Print sgn(10) REM returns 1</paragraph>
 100 <paragraph role="paragraph" id="par_id3144765" xml-lang="en-US" l10n="U" oldref="22">end sub</paragraph>
 101 </body>
 102 </helpdocument>