1*b1cdbd2cSJim Jagielski<?xml version="1.0" encoding="UTF-8"?> 2*b1cdbd2cSJim Jagielski 3*b1cdbd2cSJim Jagielski 4*b1cdbd2cSJim Jagielski<!--*********************************************************** 5*b1cdbd2cSJim Jagielski * 6*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 7*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 8*b1cdbd2cSJim Jagielski * distributed with this work for additional information 9*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 10*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 11*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 12*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 13*b1cdbd2cSJim Jagielski * 14*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 15*b1cdbd2cSJim Jagielski * 16*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 17*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 18*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 19*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 20*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 21*b1cdbd2cSJim Jagielski * under the License. 22*b1cdbd2cSJim Jagielski * 23*b1cdbd2cSJim Jagielski ***********************************************************--> 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski<helpdocument version="1.0"> 28*b1cdbd2cSJim Jagielski<meta> 29*b1cdbd2cSJim Jagielski<topic id="textsbasicshared03080701xml" indexer="include" status="PUBLISH"> 30*b1cdbd2cSJim Jagielski<title id="tit" xml-lang="en-US">Sgn Function [Runtime]</title> 31*b1cdbd2cSJim Jagielski<filename>/text/sbasic/shared/03080701.xhp</filename> 32*b1cdbd2cSJim Jagielski</topic> 33*b1cdbd2cSJim Jagielski<history> 34*b1cdbd2cSJim Jagielski<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> 35*b1cdbd2cSJim Jagielski<lastedited date="2004-08-24T14:24:24">converted from old format - fpe</lastedited> 36*b1cdbd2cSJim Jagielski</history> 37*b1cdbd2cSJim Jagielski</meta> 38*b1cdbd2cSJim Jagielski<body> 39*b1cdbd2cSJim Jagielski<section id="sgn"> 40*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="index" id="bm_id3148474"><bookmark_value>Sgn function</bookmark_value> 41*b1cdbd2cSJim Jagielski</bookmark> 42*b1cdbd2cSJim Jagielski<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> 43*b1cdbd2cSJim Jagielski<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> 44*b1cdbd2cSJim Jagielski</section> 45*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3156023" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph> 46*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3153897" xml-lang="en-US" l10n="U" oldref="4">Sgn (Number)</paragraph> 47*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3145069" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph> 48*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3150359" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph> 49*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3150543" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph> 50*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154365" xml-lang="en-US" l10n="U" oldref="8"> 51*b1cdbd2cSJim Jagielski<emph>Number:</emph> Numeric expression that determines the value that is returned by the function.</paragraph> 52*b1cdbd2cSJim Jagielski<table id="tbl_id3156281"> 53*b1cdbd2cSJim Jagielski<tablerow> 54*b1cdbd2cSJim Jagielski<tablecell colspan="" rowspan=""> 55*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3150767" xml-lang="en-US" l10n="U" oldref="9">NumExpression</paragraph> 56*b1cdbd2cSJim Jagielski</tablecell> 57*b1cdbd2cSJim Jagielski<tablecell colspan="" rowspan=""> 58*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3150441" xml-lang="en-US" l10n="U" oldref="10">Return value</paragraph> 59*b1cdbd2cSJim Jagielski</tablecell> 60*b1cdbd2cSJim Jagielski</tablerow> 61*b1cdbd2cSJim Jagielski<tablerow> 62*b1cdbd2cSJim Jagielski<tablecell colspan="" rowspan=""> 63*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3161833" xml-lang="en-US" l10n="U" oldref="11">negative</paragraph> 64*b1cdbd2cSJim Jagielski</tablecell> 65*b1cdbd2cSJim Jagielski<tablecell colspan="" rowspan=""> 66*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U" oldref="12">Sgn returns -1.</paragraph> 67*b1cdbd2cSJim Jagielski</tablecell> 68*b1cdbd2cSJim Jagielski</tablerow> 69*b1cdbd2cSJim Jagielski<tablerow> 70*b1cdbd2cSJim Jagielski<tablecell colspan="" rowspan=""> 71*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="13">0</paragraph> 72*b1cdbd2cSJim Jagielski</tablecell> 73*b1cdbd2cSJim Jagielski<tablecell colspan="" rowspan=""> 74*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U" oldref="14">Sgn returns 0.</paragraph> 75*b1cdbd2cSJim Jagielski</tablecell> 76*b1cdbd2cSJim Jagielski</tablerow> 77*b1cdbd2cSJim Jagielski<tablerow> 78*b1cdbd2cSJim Jagielski<tablecell colspan="" rowspan=""> 79*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3153139" xml-lang="en-US" l10n="U" oldref="15">positive</paragraph> 80*b1cdbd2cSJim Jagielski</tablecell> 81*b1cdbd2cSJim Jagielski<tablecell colspan="" rowspan=""> 82*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154319" xml-lang="en-US" l10n="U" oldref="16">Sgn returns 1.</paragraph> 83*b1cdbd2cSJim Jagielski</tablecell> 84*b1cdbd2cSJim Jagielski</tablerow> 85*b1cdbd2cSJim Jagielski</table> 86*b1cdbd2cSJim Jagielski<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> 87*b1cdbd2cSJim Jagielski<embed href="text/sbasic/shared/00000003.xhp#err5"/> 88*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3152576" xml-lang="en-US" level="2" l10n="U" oldref="17">Example:</paragraph> 89*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154791" xml-lang="en-US" l10n="U" oldref="18">Sub ExampleSgn</paragraph> 90*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3155416" xml-lang="en-US" l10n="U" oldref="19">Print sgn(-10) REM returns -1</paragraph> 91*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154096" xml-lang="en-US" l10n="U" oldref="20">Print sgn(0) REM returns 0</paragraph> 92*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3148457" xml-lang="en-US" l10n="U" oldref="21">Print sgn(10) REM returns 1</paragraph> 93*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3144765" xml-lang="en-US" l10n="U" oldref="22">end sub</paragraph> 94*b1cdbd2cSJim Jagielski</body> 95*b1cdbd2cSJim Jagielski</helpdocument> 96