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