<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->
<meta>
<topic id="textsbasicshared03080701xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Sgn Function</title>
<filename>/text/sbasic/shared/03080701.xhp</filename>
</topic>
</meta>
<body>
<section id="sgn">
<bookmark xml-lang="en-US" branch="index" id="bm_id3148474">
<bookmark_value>Sgn function</bookmark_value>
</bookmark>
<paragraph id="hd_id3148474" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080701.xhp" name="Sgn Function">Sgn Function</link></paragraph>
<paragraph id="par_id3148686" role="paragraph" xml-lang="en-US">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>
</section>
<paragraph id="hd_id3156023" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3153897" role="bascode" xml-lang="en-US">Sgn (Number)</paragraph>
</bascode>
<paragraph id="hd_id3145069" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
<paragraph id="par_id3150359" role="paragraph" xml-lang="en-US">Integer</paragraph>
<paragraph id="hd_id3150543" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
<paragraph id="par_id3154365" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Numeric expression that determines the value that is returned by the function.</paragraph>
<table id="tbl_id3156281">
<tablerow>
<tablecell>
<paragraph id="par_id3150767" role="paragraph" xml-lang="en-US">NumExpression</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3150441" role="paragraph" xml-lang="en-US">Return value</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id3161833" role="paragraph" xml-lang="en-US">negative</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3155306" role="paragraph" xml-lang="en-US">Sgn returns -1.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id3145271" role="paragraph" localize="false" xml-lang="en-US">0</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3146119" role="paragraph" xml-lang="en-US">Sgn returns 0.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id3153139" role="paragraph" xml-lang="en-US">positive</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id3154319" role="paragraph" xml-lang="en-US">Sgn returns 1.</paragraph>
</tablecell>
</tablerow>
</table>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<paragraph id="hd_id3152576" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1340806400" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSgn</paragraph>
<paragraph id="par_id3155416" role="bascode" xml-lang="en-US"> Print sgn(-10) ' returns -1</paragraph>
<paragraph id="par_id3154096" role="bascode" xml-lang="en-US"> Print sgn(0) ' returns 0</paragraph>
<paragraph id="par_id3148457" role="bascode" xml-lang="en-US"> Print sgn(10) ' returns 1</paragraph>
<paragraph id="par_idm1340799936" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>
</helpdocument>