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