source/text/sbasic/shared/00000003.xhp | 340 ++++++++++++++++----------------- source/text/sbasic/shared/03102800.xhp | 34 ++- source/text/sbasic/shared/03104400.xhp | 59 ++++- source/text/sbasic/shared/03104600.xhp | 40 +++ source/text/sbasic/shared/03132300.xhp | 65 ++++-- 5 files changed, 332 insertions(+), 206 deletions(-)
New commits: commit 50ac2a4859e37571f39df2a00a250d0d97db121f Author: Olivier Hallot <olivier.hal...@libreoffice.org> AuthorDate: Mon Apr 14 17:45:01 2025 -0300 Commit: Olivier Hallot <olivier.hal...@libreoffice.org> CommitDate: Mon Apr 14 22:49:05 2025 +0200 tdf#163745 BASIC help pages must explicitly state types Change-Id: Id1c8a68f91b325afd0dd678cfb003d5922100351 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/184180 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hal...@libreoffice.org> diff --git a/source/text/sbasic/shared/03102800.xhp b/source/text/sbasic/shared/03102800.xhp index 82d636e222..e1b6e71f95 100644 --- a/source/text/sbasic/shared/03102800.xhp +++ b/source/text/sbasic/shared/03102800.xhp @@ -20,7 +20,7 @@ <meta> <topic id="textsbasicshared03102800xml" indexer="include" status="PUBLISH"> - <title id="tit" xml-lang="en-US">IsObject Function</title> + <title id="tit">IsObject Function</title> <filename>/text/sbasic/shared/03102800.xhp</filename> </topic> <history> @@ -29,11 +29,11 @@ </meta> <body> <section id="isobject"> - <bookmark xml-lang="en-US" branch="index" id="bm_id3149346"> + <bookmark branch="index" id="bm_id3149346"> <bookmark_value>IsObject function</bookmark_value> </bookmark> <h1 id="hd_id51633474369322"><variable id="IsObject_h1"><link href="text/sbasic/shared/03102800.xhp">IsObject Function</link></variable></h1> - <paragraph role="paragraph" id="par_id3148538" xml-lang="en-US">Tests if a variable is an object, as opposed to primitive data types such as dates, numbers, texts. The function returns <literal>True</literal> if the variable is an object, otherwise it returns <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id3148538">Tests if a variable is an object, as opposed to primitive data types such as dates, numbers, texts. The function returns <literal>True</literal> if the variable is an object, otherwise it returns <literal>False</literal>.</paragraph> </section> <paragraph role="paragraph" id="par_id891575896963115">This function returns <literal>True</literal> for the following object types:</paragraph> <list type="unordered"> @@ -49,10 +49,32 @@ <input>IsObject(var)</input> </paragraph> <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> - <paragraph role="paragraph" id="par_id3156024" xml-lang="en-US">Boolean</paragraph> + <paragraph role="paragraph" id="par_id3156024">Boolean</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> - <paragraph role="paragraph" id="par_id3148552" xml-lang="en-US"> - <emph>var:</emph> The variable to be tested.</paragraph> + <table id="tab_id951744656264278"> + <tablerow> + <tablecell> + <paragraph id="par_id641744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_name" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id511744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_type" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_desc" markup="ignore"/></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471744656264278" role="tablecontent">var</paragraph> + </tablecell> + <tablecell> + </tablecell> + <tablecell> + <paragraph id="par_id801744656264278" role="tablecontent">The variable to be tested.</paragraph> + </tablecell> + </tablerow> +</table> <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> <embed href="text/sbasic/shared/00000003.xhp#err5"/> diff --git a/source/text/sbasic/shared/03104600.xhp b/source/text/sbasic/shared/03104600.xhp index 5a0e3d9584..0b4e5b9188 100644 --- a/source/text/sbasic/shared/03104600.xhp +++ b/source/text/sbasic/shared/03104600.xhp @@ -40,10 +40,44 @@ <paragraph role="paragraph" localize="false" id="par_id711633530276845"> <input>EqualUnoObjects(oObj1, oObj2)</input> </paragraph> - <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> - <paragraph role="paragraph" id="par_id61633530293311"><emph>oObj1, oObj2:</emph> the variables to be tested.</paragraph> - <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> <paragraph role="paragraph" id="par_id3154285">Bool</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <table id="tab_id951744656264278"> + <tablerow> + <tablecell> + <paragraph id="par_id641744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_name" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id511744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_type" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_desc" markup="ignore"/></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471744656264278" role="tablecontent">oObj1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id481744656264278" role="tablecontent" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id801744656264278" role="tablecontent">the first Basic Uno object.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311744656367084" role="tablecontent">oObj2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701744656380892" role="tablecontent" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201744656388588" role="tablecontent">the second Basic Uno object.</paragraph> + </tablecell> + </tablerow> +</table> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> <paragraph role="paragraph" id="par_id771633473462939">The example below returns <emph>True</emph> because both <literal>oDoc</literal> and <literal>ThisComponent</literal> are references to the same object:</paragraph> <bascode> diff --git a/source/text/sbasic/shared/03132300.xhp b/source/text/sbasic/shared/03132300.xhp index 2bcf886671..ef7a646379 100644 --- a/source/text/sbasic/shared/03132300.xhp +++ b/source/text/sbasic/shared/03132300.xhp @@ -1,5 +1,4 @@ <?xml version="1.0" encoding="UTF-8"?> - <!-- * This file is part of the LibreOffice project. * @@ -17,11 +16,10 @@ * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . --> - <helpdocument version="1.0"> <meta> <topic id="textsbasicshared03132300xml" indexer="include" status="PUBLISH"> -<title id="tit" xml-lang="en-US">CreateUnoValue Function</title> +<title id="tit">CreateUnoValue Function</title> <filename>/text/sbasic/shared/03132300.xhp</filename> </topic> <history> @@ -30,14 +28,14 @@ </meta> <body> <section id="createunovalue"> -<bookmark xml-lang="en-US" branch="index" id="bm_id3150682"><bookmark_value>CreateUnoValue function</bookmark_value> +<bookmark branch="index" id="bm_id3150682"><bookmark_value>CreateUnoValue function</bookmark_value> </bookmark> -<h1 id="hd_id3150682" xml-lang="en-US"><link href="text/sbasic/shared/03132300.xhp">CreateUnoValue Function</link></h1> -<paragraph role="paragraph" id="par_id3147291" xml-lang="en-US">Returns an object that represents a strictly typed value referring to the Uno type system. </paragraph> +<h1 id="hd_id3150682"><link href="text/sbasic/shared/03132300.xhp">CreateUnoValue Function</link></h1> +<paragraph role="paragraph" id="par_id3147291">Returns an object that represents a strictly typed value referring to the Uno type system. </paragraph> </section> -<paragraph role="paragraph" id="par_id3143267" xml-lang="en-US">This object is automatically converted to an <literal>Any</literal> of the corresponding type when passed to Uno. The type must be specified by its fully qualified Uno type name.</paragraph> -<paragraph role="note" id="par_id3153626" xml-lang="en-US">The $[officename] API frequently uses the <literal>Any</literal> type. It is the counterpart of the <literal>Variant</literal> type known from other environments. The <literal>Any</literal> type holds one arbitrary Uno type and is used in generic Uno interfaces.</paragraph> +<paragraph role="paragraph" id="par_id3143267">This object is automatically converted to an <literal>Any</literal> of the corresponding type when passed to Uno. The type must be specified by its fully qualified Uno type name.</paragraph> +<note id="par_id3153626">The $[officename] API frequently uses the <literal>Any</literal> type. It is the counterpart of the <literal>Variant</literal> type known from other environments. The <literal>Any</literal> type holds one arbitrary Uno type and is used in generic Uno interfaces.</note> <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> <bascode> @@ -48,17 +46,50 @@ <paragraph role="paragraph" id="par_id851677925987795">Object</paragraph> <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> -<paragraph role="paragraph" id="par_id561677933999834"> <emph>Type</emph>: The fully qualified Uno type name. Supported data types are <literal>void</literal>, <literal>char</literal>, <literal>boolean</literal>, <literal>byte</literal>, <literal>short</literal>, <literal>unsigned short</literal>, <literal>long</literal>, <literal>unsigned long</literal>, <literal>hyper</literal>, <literal>unsigned hyper</literal>, <literal>float</literal>, <literal>double</literal>, <literal>string</literal>, <literal>type</literal>, and <literal>any</literal>. Names are case sensitive and may be preceded by square brackets to indicate an array.</paragraph> -<paragraph role="paragraph" id="par_id521677934011767"> <emph>Value</emph>: A strictly typed value.</paragraph> +<table id="tab_id951744656264278"> + <tablerow> + <tablecell> + <paragraph id="par_id641744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_name" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id511744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_type" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_desc" markup="ignore"/></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471744656264278" role="tablecontent">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id481744656264278" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id801744656264278" role="tablecontent">The fully qualified Uno type name. Supported data types are <literal>void</literal>, <literal>char</literal>, <literal>boolean</literal>, <literal>byte</literal>, <literal>short</literal>, <literal>unsigned short</literal>, <literal>long</literal>, <literal>unsigned long</literal>, <literal>hyper</literal>, <literal>unsigned hyper</literal>, <literal>float</literal>, <literal>double</literal>, <literal>string</literal>, <literal>type</literal>, and <literal>any</literal>. Names are case sensitive and may be preceded by square brackets to indicate an array.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311744656367084" role="tablecontent">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701744656380892" role="tablecontent" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201744656388588" role="tablecontent">A strictly typed value.</paragraph> + </tablecell> + </tablerow> +</table> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<paragraph role="paragraph" id="par_id3150541">If <literal>CreateUnoValue</literal> cannot convert the value to the specified Uno type, an error occurs. The <literal>com.sun.star.script.Converter</literal> service is responsible for the conversion.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> <bascode> <paragraph role="bascode" id="bas_id111677934830145" localize="false">byte_sequence_object = CreateUnoValue("[]byte", Array(85, 3, 27))</paragraph> </bascode> - -<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> -<paragraph role="paragraph" id="par_id3150541" xml-lang="en-US">If <literal>CreateUnoValue</literal> cannot convert the value to the specified Uno type, an error occurs. The <literal>com.sun.star.script.Converter</literal> service is responsible for the conversion.</paragraph> - <embed href="text/sbasic/shared/00000003.xhp#functexample"/> -<paragraph role="paragraph" id="par_id3153524" xml-lang="en-US">This function is intended for use in situations where the default Basic to Uno type converting mechanism is insufficient. This happens calling generic <literal>Any</literal> based API methods, such as <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1beans_1_1XPropertySet.html">com.sun.star.beans.XPropertySet</link><literal>.setPropertyValue()</literal> or <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1container_1_1XNameContainer.html">com.sun.star.container.XNameContainer</link><literal>.insertByName()</literal>. <literal>CreateUnoValue()</literal> sets a value object for the unknown Uno type.</paragraph> +<paragraph role="paragraph" id="par_id3153524">This function is intended for use in situations where the default Basic to Uno type converting mechanism is insufficient. This happens calling generic <literal>Any</literal> based API methods, such as <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1beans_1_1XPropertySet.html">com.sun.star.beans.XPropertySet</link><literal>.setPropertyValue()</literal> or <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1container_1_1XNameContainer.html">com.sun.star.container.XNameContainer</link><literal>.insertByName()</literal>. <literal>CreateUnoValue()</literal> sets a value object for the unknown Uno type.</paragraph> <paragraph role="paragraph" id="par_id511677928924995">This example uses <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1beans_1_1XPropertySet.html">com.sun.star.beans.XPropertySet</link><literal>.addProperty()</literal> method to create a document property whose default values requires <literal>CreateUnoValue()</literal> usage:</paragraph> <bascode> @@ -66,6 +97,6 @@ <paragraph role="bascode" id="bas_id981677936008973" localize="false"> .addProperty("FOO", com.sun.star.beans.PropertyAttribute.REMOVEABLE, CreateUnoValue("double", 23))</paragraph> <paragraph role="bascode" id="bas_id181677936010027" localize="false">End With </paragraph> </bascode> -<paragraph role="paragraph" id="par_id3150769" xml-lang="en-US">You can also use this function to pass non-Any values, but this is not recommended. If Basic already knows the target type, using the <literal>CreateUnoValue()</literal> function will only lead to additional converting operations that slow down the Basic execution.</paragraph> +<paragraph role="paragraph" id="par_id3150769">You can also use this function to pass non-Any values, but this is not recommended. If Basic already knows the target type, using the <literal>CreateUnoValue()</literal> function will only lead to additional converting operations that slow down the Basic execution.</paragraph> </body> -</helpdocument> \ No newline at end of file +</helpdocument> commit 665361b6e25061def1bb387eb4c2b3c9fbee5c62 Author: Olivier Hallot <olivier.hal...@libreoffice.org> AuthorDate: Mon Apr 14 16:34:49 2025 -0300 Commit: Olivier Hallot <olivier.hal...@libreoffice.org> CommitDate: Mon Apr 14 22:48:53 2025 +0200 tdf#163745 BASIC help pages must explicitly state types + refactor for simplification + changed parameter description section to a table layout + tweaks to spare translations + changed "Return value" to "Return type" because it refers to the type of the returned value. Change-Id: I4fce2473866c1417bf30c82be11dc79417d1445d Reviewed-on: https://gerrit.libreoffice.org/c/help/+/184178 Reviewed-by: Olivier Hallot <olivier.hal...@libreoffice.org> Tested-by: Jenkins diff --git a/source/text/sbasic/shared/00000003.xhp b/source/text/sbasic/shared/00000003.xhp index 72b0f59d1b..1abbf9c9b7 100644 --- a/source/text/sbasic/shared/00000003.xhp +++ b/source/text/sbasic/shared/00000003.xhp @@ -19,166 +19,166 @@ --> <meta> <topic id="textsbasicshared00000003xml" indexer="exclude" status="PUBLISH"> - <title id="tit" xml-lang="en-US">Information</title> + <title id="tit">Information</title> <filename>/text/sbasic/shared/00000003.xhp</filename> </topic> </meta> <body> <h1 id="hd_id3148550">Information</h1> <section id="languageformat"> -<paragraph id="par_id3153381" role="paragraph" xml-lang="en-US">You can set the locale used for controlling the formatting numbers, dates and currencies in $[officename] Basic in <switchinline select="sys"><caseinline select="MAC"><emph>%PRODUCTNAME - Preferences</emph> +<paragraph id="par_id3153381" role="paragraph">You can set the locale used for controlling the formatting numbers, dates and currencies in $[officename] Basic in <switchinline select="sys"><caseinline select="MAC"><emph>%PRODUCTNAME - Preferences</emph> </caseinline><defaultinline><emph>Tools - Options</emph></defaultinline></switchinline><emph> - Languages and Locales - General</emph>. In Basic format codes, the decimal point (<emph>.</emph>) is always used as <emph>placeholder</emph> for the decimal separator defined in your locale and will be replaced by the corresponding character.</paragraph> -<paragraph id="par_id3150870" role="paragraph" xml-lang="en-US">The same applies to the locale settings for date, time and currency formats. The Basic format code will be interpreted and displayed according to your locale setting.</paragraph> +<paragraph id="par_id3150870" role="paragraph">The same applies to the locale settings for date, time and currency formats. The Basic format code will be interpreted and displayed according to your locale setting.</paragraph> </section> <section id="colorcodes"> -<paragraph id="par_id3156424" role="paragraph" xml-lang="en-US">The color values of the 16 basic colors are as follows:</paragraph> +<paragraph id="par_id3156424" role="paragraph">The color values of the 16 basic colors are as follows:</paragraph> <table id="tbl_id3147434"> <tablerow> <tablecell> - <paragraph id="par_id3153091" role="tablehead" xml-lang="en-US"><emph>Color Value</emph></paragraph> + <paragraph id="par_id3153091" role="tablehead"><emph>Color Value</emph></paragraph> </tablecell> <tablecell> - <paragraph id="par_id3154319" role="tablehead" xml-lang="en-US"><emph>Color Name</emph></paragraph> + <paragraph id="par_id3154319" role="tablehead"><emph>Color Name</emph></paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3151112" role="tablecontent" xml-lang="en-US">0</paragraph> + <paragraph id="par_id3151112" role="tablecontent">0</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3155854" role="tablecontent" xml-lang="en-US">Black</paragraph> + <paragraph id="par_id3155854" role="tablecontent">Black</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3154942" role="tablecontent" xml-lang="en-US">128</paragraph> + <paragraph id="par_id3154942" role="tablecontent">128</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3154731" role="tablecontent" xml-lang="en-US">Blue</paragraph> + <paragraph id="par_id3154731" role="tablecontent">Blue</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3145645" role="tablecontent" xml-lang="en-US">32768</paragraph> + <paragraph id="par_id3145645" role="tablecontent">32768</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3149400" role="tablecontent" xml-lang="en-US">Green</paragraph> + <paragraph id="par_id3149400" role="tablecontent">Green</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3150753" role="tablecontent" xml-lang="en-US">32896</paragraph> + <paragraph id="par_id3150753" role="tablecontent">32896</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3153765" role="tablecontent" xml-lang="en-US">Cyan</paragraph> + <paragraph id="par_id3153765" role="tablecontent">Cyan</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3154756" role="tablecontent" xml-lang="en-US">8388608</paragraph> + <paragraph id="par_id3154756" role="tablecontent">8388608</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3159266" role="tablecontent" xml-lang="en-US">Red</paragraph> + <paragraph id="par_id3159266" role="tablecontent">Red</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3163807" role="tablecontent" xml-lang="en-US">8388736</paragraph> + <paragraph id="par_id3163807" role="tablecontent">8388736</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3145150" role="tablecontent" xml-lang="en-US">Magenta</paragraph> + <paragraph id="par_id3145150" role="tablecontent">Magenta</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3147002" role="tablecontent" xml-lang="en-US">8421376</paragraph> + <paragraph id="par_id3147002" role="tablecontent">8421376</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3152778" role="tablecontent" xml-lang="en-US">Yellow</paragraph> + <paragraph id="par_id3152778" role="tablecontent">Yellow</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3150088" role="tablecontent" xml-lang="en-US">8421504</paragraph> + <paragraph id="par_id3150088" role="tablecontent">8421504</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3159239" role="tablecontent" xml-lang="en-US">White</paragraph> + <paragraph id="par_id3159239" role="tablecontent">White</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3150206" role="tablecontent" xml-lang="en-US">12632256</paragraph> + <paragraph id="par_id3150206" role="tablecontent">12632256</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3149817" role="tablecontent" xml-lang="en-US">Gray</paragraph> + <paragraph id="par_id3149817" role="tablecontent">Gray</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3150363" role="tablecontent" xml-lang="en-US">255</paragraph> + <paragraph id="par_id3150363" role="tablecontent">255</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3154576" role="tablecontent" xml-lang="en-US">Light blue</paragraph> + <paragraph id="par_id3154576" role="tablecontent">Light blue</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3150367" role="tablecontent" xml-lang="en-US">65280</paragraph> + <paragraph id="par_id3150367" role="tablecontent">65280</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3150202" role="tablecontent" xml-lang="en-US">Light green</paragraph> + <paragraph id="par_id3150202" role="tablecontent">Light green</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3154487" role="tablecontent" xml-lang="en-US">65535</paragraph> + <paragraph id="par_id3154487" role="tablecontent">65535</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3151332" role="tablecontent" xml-lang="en-US">Light cyan</paragraph> + <paragraph id="par_id3151332" role="tablecontent">Light cyan</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3148702" role="tablecontent" xml-lang="en-US">16711680</paragraph> + <paragraph id="par_id3148702" role="tablecontent">16711680</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3153067" role="tablecontent" xml-lang="en-US">Light red</paragraph> + <paragraph id="par_id3153067" role="tablecontent">Light red</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3153912" role="tablecontent" xml-lang="en-US">16711935</paragraph> + <paragraph id="par_id3153912" role="tablecontent">16711935</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3159097" role="tablecontent" xml-lang="en-US">Light magenta</paragraph> + <paragraph id="par_id3159097" role="tablecontent">Light magenta</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3155266" role="tablecontent" xml-lang="en-US">16776960</paragraph> + <paragraph id="par_id3155266" role="tablecontent">16776960</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3157978" role="tablecontent" xml-lang="en-US">Light yellow</paragraph> + <paragraph id="par_id3157978" role="tablecontent">Light yellow</paragraph> </tablecell> </tablerow> <tablerow> <tablecell> - <paragraph id="par_id3153286" role="tablecontent" xml-lang="en-US">16777215</paragraph> + <paragraph id="par_id3153286" role="tablecontent">16777215</paragraph> </tablecell> <tablecell> - <paragraph id="par_id3151302" role="tablecontent" xml-lang="en-US">Transparent white</paragraph> + <paragraph id="par_id3151302" role="tablecontent">Transparent white</paragraph> </tablecell> </tablerow> </table> </section> <section id="dialoglibhowtoget"> - <paragraph role="paragraph" id="par_id631529990528928" xml-lang="en-US">Open <item type="menuitem">Tools - Macros - Organize Dialogs</item> and select <item type="menuitem">%PRODUCTNAME Dialogs</item> container.</paragraph> + <paragraph role="paragraph" id="par_id631529990528928">Open <item type="menuitem">Tools - Macros - Organize Dialogs</item> and select <item type="menuitem">%PRODUCTNAME Dialogs</item> container.</paragraph> </section> <section id="basiclibhowtoget"> - <paragraph role="paragraph" id="par_id631529000528928" xml-lang="en-US">Open <item type="menuitem">Tools - Macros - %PRODUCTNAME Basic - Edit</item> and select <item type="menuitem">Application Macros</item> container.</paragraph> + <paragraph role="paragraph" id="par_id631529000528928">Open <item type="menuitem">Tools - Macros - %PRODUCTNAME Basic - Edit</item> and select <item type="menuitem">Application Macros</item> container.</paragraph> </section> <section id="basiclibwarning"> - <paragraph role="paragraph" id="par_id971529072633266" xml-lang="en-US"><variable id="basiclibrarynote">This library must be loaded before execution. Execute the following statement before running any macro that uses this library:</variable></paragraph> + <paragraph role="paragraph" id="par_id971529072633266"><variable id="basiclibrarynote">This library must be loaded before execution. Execute the following statement before running any macro that uses this library:</variable></paragraph> </section> <section id="vbasupport"> <warning id="par_id051920171018124524">This constant, function or object is enabled with the statement <link href="text/sbasic/shared/03103350.xhp"><literal>Option VBASupport 1</literal></link> placed before the executable program code in a module.</warning> @@ -190,7 +190,7 @@ <h2 id="hd_id061420171139089682"><variable id="functsyntax">Syntax:</variable></h2> </section> <section id="functvalue"> -<h2 id="hd_id061420171139087480"><variable id="functvalue">Return value:</variable></h2> +<h2 id="hd_id061420171139087480"><variable id="functvalue">Return type:</variable></h2> </section> <section id="functparameters"> <h2 id="hd_id061420171139084157"><variable id="functparameters">Parameters:</variable></h2> @@ -216,137 +216,141 @@ <section id="Python_Support"> <note id="par_id21624295605301">This service is fully supported in both Basic and Python languages. All examples are expressed using the Basic programming language and can be easily converted to Python.</note> </section> +<paragraph role="paragraph" id="par_id101744658565132"><variable id="param_name">Name</variable></paragraph> +<paragraph role="paragraph" id="par_id71744658569429"><variable id="param_type">Type</variable></paragraph> +<paragraph role="paragraph" id="par_id111744658573700"><variable id="param_desc">Description</variable></paragraph> + <paragraph role="paragraph" id="par_id161599082457466"><variable id="stringfunctions"><link href="text/sbasic/shared/03120300.xhp">String functions</link></variable></paragraph> -<paragraph id="par_id06142017015837916" role="paragraph" xml-lang="en-US"><variable id="VBA-Financial"><link href="text/sbasic/shared/special_vba_func.xhp#VBAFinancial">VBA financial functions</link></variable></paragraph> -<paragraph id="par_id06142017016837917" role="paragraph" xml-lang="en-US"><variable id="VBATimeAndDate"><link href="text/sbasic/shared/special_vba_func.xhp#VBADateTime">VBA Time and Date functions</link></variable></paragraph> -<paragraph id="par_id06142017016837918" role="paragraph" xml-lang="en-US"><variable id="VBAIO"><link href="text/sbasic/shared/special_vba_func.xhp#VBAIO">VBA I/O functions</link></variable></paragraph> -<paragraph id="par_id06142017016837919" role="paragraph" xml-lang="en-US"><variable id="VBAMath"><link href="text/sbasic/shared/special_vba_func.xhp#VBAMath">VBA Mathematical functions</link></variable></paragraph> -<paragraph id="par_id06142017016837920" role="paragraph" xml-lang="en-US"><variable id="VBAObject"><link href="text/sbasic/shared/special_vba_func.xhp#VBAObject">VBA Object functions</link></variable></paragraph> +<paragraph id="par_id06142017015837916" role="paragraph"><variable id="VBA-Financial"><link href="text/sbasic/shared/special_vba_func.xhp#VBAFinancial">VBA financial functions</link></variable></paragraph> +<paragraph id="par_id06142017016837917" role="paragraph"><variable id="VBATimeAndDate"><link href="text/sbasic/shared/special_vba_func.xhp#VBADateTime">VBA Time and Date functions</link></variable></paragraph> +<paragraph id="par_id06142017016837918" role="paragraph"><variable id="VBAIO"><link href="text/sbasic/shared/special_vba_func.xhp#VBAIO">VBA I/O functions</link></variable></paragraph> +<paragraph id="par_id06142017016837919" role="paragraph"><variable id="VBAMath"><link href="text/sbasic/shared/special_vba_func.xhp#VBAMath">VBA Mathematical functions</link></variable></paragraph> +<paragraph id="par_id06142017016837920" role="paragraph"><variable id="VBAObject"><link href="text/sbasic/shared/special_vba_func.xhp#VBAObject">VBA Object functions</link></variable></paragraph> <section id="errorcode"> <h2 id="hd_id3152869"><variable id="errorcode">Error codes:</variable></h2> </section> <section id="allerrors"> -<paragraph id="par_id315509599" role="paragraph" xml-lang="en-US"><variable id="err1">1 An exception occurred</variable></paragraph> -<paragraph id="par_id3155095" role="paragraph" xml-lang="en-US"><variable id="err2">2 Syntax error</variable></paragraph> -<paragraph id="par_id3149126" role="paragraph" xml-lang="en-US"><variable id="err3">3 Return without Gosub</variable></paragraph> -<paragraph id="par_id3153976" role="paragraph" xml-lang="en-US"><variable id="err4">4 Incorrect entry; please retry</variable></paragraph> -<paragraph id="par_id3150891" role="paragraph" xml-lang="en-US"><variable id="err5">5 Invalid procedure call</variable></paragraph> -<paragraph id="par_id3159227" role="paragraph" xml-lang="en-US"><variable id="err6">6 Overflow</variable></paragraph> -<paragraph id="par_id3154649" role="paragraph" xml-lang="en-US"><variable id="err7">7 Not enough memory</variable></paragraph> -<paragraph id="par_id3150050" role="paragraph" xml-lang="en-US"><variable id="err8">8 Array already dimensioned</variable></paragraph> -<paragraph id="par_id3148900" role="paragraph" xml-lang="en-US"><variable id="err9">9 Index out of defined range</variable></paragraph> -<paragraph id="par_id3153806" role="paragraph" xml-lang="en-US"><variable id="err10">10 Duplicate definition</variable></paragraph> -<paragraph id="par_id3146963" role="paragraph" xml-lang="en-US"><variable id="err11">11 Division by zero</variable></paragraph> -<paragraph id="par_id3153013" role="paragraph" xml-lang="en-US"><variable id="err12">12 Variable not defined</variable></paragraph> -<paragraph id="par_id3155593" role="paragraph" xml-lang="en-US"><variable id="err13">13 Data type mismatch</variable></paragraph> -<paragraph id="par_id3151197" role="paragraph" xml-lang="en-US"><variable id="err14">14 Invalid parameter</variable></paragraph> -<paragraph id="par_id3154710" role="paragraph" xml-lang="en-US"><variable id="err18">18 Process interrupted by user</variable></paragraph> -<paragraph id="par_id3147504" role="paragraph" xml-lang="en-US"><variable id="err20">20 Resume without error</variable></paragraph> -<paragraph id="par_id3145319" role="paragraph" xml-lang="en-US"><variable id="err28">28 Not enough stack memory</variable></paragraph> -<paragraph id="par_id3146110" role="paragraph" xml-lang="en-US"><variable id="err35">35 Sub-procedure or function procedure not defined</variable></paragraph> -<paragraph id="par_id3147246" role="paragraph" xml-lang="en-US"><variable id="err48">48 Error loading DLL file</variable></paragraph> -<paragraph id="par_id3146101" role="paragraph" xml-lang="en-US"><variable id="err49">49 Wrong DLL call convention</variable></paragraph> -<paragraph id="par_id3153957" role="paragraph" xml-lang="en-US"><variable id="err51">51 Internal error</variable></paragraph> -<paragraph id="par_id3154404" role="paragraph" xml-lang="en-US"><variable id="err52">52 Invalid file name or file number</variable></paragraph> -<paragraph id="par_id3151338" role="paragraph" xml-lang="en-US"><variable id="err53">53 File not found</variable></paragraph> -<paragraph id="par_id3147298" role="paragraph" xml-lang="en-US"><variable id="err54">54 Incorrect file mode</variable></paragraph> -<paragraph id="par_id3148747" role="paragraph" xml-lang="en-US"><variable id="err55">55 File already open</variable></paragraph> -<paragraph id="par_id3145233" role="paragraph" xml-lang="en-US"><variable id="err57">57 Device I/O error</variable></paragraph> -<paragraph id="par_id3156399" role="paragraph" xml-lang="en-US"><variable id="err58">58 File already exists</variable></paragraph> -<paragraph id="par_id3149324" role="paragraph" xml-lang="en-US"><variable id="err59">59 Incorrect record length</variable></paragraph> -<paragraph id="par_id3147409" role="paragraph" xml-lang="en-US"><variable id="err61">61 Disk or hard drive full</variable></paragraph> -<paragraph id="par_id3149146" role="paragraph" xml-lang="en-US"><variable id="err62">62 Reading exceeds EOF</variable></paragraph> -<paragraph id="par_id3150456" role="paragraph" xml-lang="en-US"><variable id="err63">63 Incorrect record number</variable></paragraph> -<paragraph id="par_id3146883" role="paragraph" xml-lang="en-US"><variable id="err67">67 Too many files</variable></paragraph> -<paragraph id="par_id3146818" role="paragraph" xml-lang="en-US"><variable id="err68">68 Device not available</variable></paragraph> -<paragraph id="par_id3145225" role="paragraph" xml-lang="en-US"><variable id="err70">70 Access denied</variable></paragraph> -<paragraph id="par_id3150372" role="paragraph" xml-lang="en-US"><variable id="err71">71 Disk not ready</variable></paragraph> -<paragraph id="par_id3148894" role="paragraph" xml-lang="en-US"><variable id="err73">73 Not implemented</variable></paragraph> -<paragraph id="par_id3152981" role="paragraph" xml-lang="en-US"><variable id="err74">74 Renaming on different drives impossible</variable></paragraph> -<paragraph id="par_id3149355" role="paragraph" xml-lang="en-US"><variable id="err75">75 Path/file access error</variable></paragraph> -<paragraph id="par_id3150477" role="paragraph" xml-lang="en-US"><variable id="err76">76 Path not found</variable></paragraph> -<paragraph id="par_id3154678" role="paragraph" xml-lang="en-US"><variable id="err91">91 Object variable not set</variable></paragraph> -<paragraph id="par_id3149890" role="paragraph" xml-lang="en-US"><variable id="err93">93 Invalid string pattern</variable></paragraph> -<paragraph id="par_id3146942" role="paragraph" xml-lang="en-US"><variable id="err94">94 Use of zero not permitted</variable></paragraph> -<paragraph id="par_id31469429" role="paragraph" xml-lang="en-US"><variable id="err250">250 DDE Error</variable></paragraph> -<paragraph id="par_id31469428" role="paragraph" xml-lang="en-US"><variable id="err280">280 Awaiting response to DDE connection</variable></paragraph> -<paragraph id="par_id31469427" role="paragraph" xml-lang="en-US"><variable id="err281">281 No DDE channels available</variable></paragraph> -<paragraph id="par_id31469426" role="paragraph" xml-lang="en-US"><variable id="err282">282 No application responded to DDE connect initiation</variable></paragraph> -<paragraph id="par_id31469425" role="paragraph" xml-lang="en-US"><variable id="err283">283 Too many applications responded to DDE connect initiation</variable></paragraph> -<paragraph id="par_id31469424" role="paragraph" xml-lang="en-US"><variable id="err284">284 DDE channel locked</variable></paragraph> -<paragraph id="par_id31469423" role="paragraph" xml-lang="en-US"><variable id="err285">285 External application cannot execute DDE operation</variable></paragraph> -<paragraph id="par_id31469422" role="paragraph" xml-lang="en-US"><variable id="err286">286 Timeout while waiting for DDE response</variable></paragraph> -<paragraph id="par_id31469421" role="paragraph" xml-lang="en-US"><variable id="err287">287 user pressed ESCAPE during DDE operation</variable></paragraph> -<paragraph id="par_id31469420" role="paragraph" xml-lang="en-US"><variable id="err288">288 External application busy</variable></paragraph> -<paragraph id="par_id31469419" role="paragraph" xml-lang="en-US"><variable id="err289">289 DDE operation without data</variable></paragraph> -<paragraph id="par_id31469418" role="paragraph" xml-lang="en-US"><variable id="err290">290 Data are in wrong format</variable></paragraph> -<paragraph id="par_id31469417" role="paragraph" xml-lang="en-US"><variable id="err291">291 External application has been terminated</variable></paragraph> -<paragraph id="par_id31469416" role="paragraph" xml-lang="en-US"><variable id="err292">292 DDE connection interrupted or modified</variable></paragraph> -<paragraph id="par_id31469415" role="paragraph" xml-lang="en-US"><variable id="err293">293 DDE method invoked with no channel open</variable></paragraph> -<paragraph id="par_id31469414" role="paragraph" xml-lang="en-US"><variable id="err294">294 Invalid DDE link format</variable></paragraph> -<paragraph id="par_id31469413" role="paragraph" xml-lang="en-US"><variable id="err295">295 DDE message has been lost</variable></paragraph> -<paragraph id="par_id31469412" role="paragraph" xml-lang="en-US"><variable id="err296">296 Paste link already performed</variable></paragraph> -<paragraph id="par_id31469411" role="paragraph" xml-lang="en-US"><variable id="err297">297 Link mode cannot be set due to invalid link topic</variable></paragraph> -<paragraph id="par_id31469410" role="paragraph" xml-lang="en-US"><variable id="err298">298 DDE requires the DDEML.DLL file</variable></paragraph> -<paragraph id="par_id3150028" role="paragraph" xml-lang="en-US"><variable id="err323">323 Module cannot be loaded; invalid format</variable></paragraph> -<paragraph id="par_id3148434" role="paragraph" xml-lang="en-US"><variable id="err341">341 Invalid object index</variable></paragraph> -<paragraph id="par_id3143219" role="paragraph" xml-lang="en-US"><variable id="err366">366 Object is not available</variable></paragraph> -<paragraph id="par_id3144744" role="paragraph" xml-lang="en-US"><variable id="err380">380 Incorrect property value</variable></paragraph> -<paragraph id="par_id3147420" role="paragraph" xml-lang="en-US"><variable id="err382">382 This property is read-only</variable></paragraph> -<paragraph id="par_id3147472" role="paragraph" xml-lang="en-US"><variable id="err394">394 This property is write-only</variable></paragraph> -<paragraph id="par_id3148583" role="paragraph" xml-lang="en-US"><variable id="err420">420 Invalid object reference</variable></paragraph> -<paragraph id="par_id3153329" role="paragraph" xml-lang="en-US"><variable id="err423">423 Property or method not found</variable></paragraph> -<paragraph id="par_id3148738" role="paragraph" xml-lang="en-US"><variable id="err424">424 Object required</variable></paragraph> -<paragraph id="par_id3159084" role="paragraph" xml-lang="en-US"><variable id="err425">425 Invalid use of an object</variable></paragraph> -<paragraph id="par_id3146806" role="paragraph" xml-lang="en-US"><variable id="err430">430 OLE Automation is not supported by this object</variable></paragraph> -<paragraph id="par_id3146130" role="paragraph" xml-lang="en-US"><variable id="err438">438 This property or method is not supported by the object</variable></paragraph> -<paragraph id="par_id3154374" role="paragraph" xml-lang="en-US"><variable id="err440">440 OLE automation error</variable></paragraph> -<paragraph id="par_id3149685" role="paragraph" xml-lang="en-US"><variable id="err445">445 This action is not supported by given object</variable></paragraph> -<paragraph id="par_id3150282" role="paragraph" xml-lang="en-US"><variable id="err446">446 Named arguments are not supported by given object</variable></paragraph> -<paragraph id="par_id3150142" role="paragraph" xml-lang="en-US"><variable id="err447">447 The current locale setting is not supported by the given object</variable></paragraph> -<paragraph id="par_id3152771" role="paragraph" xml-lang="en-US"><variable id="err448">448 Named argument not found</variable></paragraph> -<paragraph id="par_id3145145" role="paragraph" xml-lang="en-US"><variable id="err449">449 Argument is not optional</variable></paragraph> -<paragraph id="par_id3154399" role="paragraph" xml-lang="en-US"><variable id="err450">450 Invalid number of arguments</variable></paragraph> -<paragraph id="par_id3146137" role="paragraph" xml-lang="en-US"><variable id="err451">451 Object is not a list</variable></paragraph> -<paragraph id="par_id3149507" role="paragraph" xml-lang="en-US"><variable id="err452">452 Invalid ordinal number</variable></paragraph> -<paragraph id="par_id3154566" role="paragraph" xml-lang="en-US"><variable id="err453">453 Specified DLL function not found</variable></paragraph> -<paragraph id="par_id3145595" role="paragraph" xml-lang="en-US"><variable id="err460">460 Invalid clipboard format</variable></paragraph> -<paragraph id="par_id31455951" role="paragraph" xml-lang="en-US"><variable id="err951">951 Unexpected symbol:</variable></paragraph> -<paragraph id="par_id31455952" role="paragraph" xml-lang="en-US"><variable id="err952">952 Expected:</variable></paragraph> -<paragraph id="par_id31455953" role="paragraph" xml-lang="en-US"><variable id="err953">953 Symbol expected</variable></paragraph> -<paragraph id="par_id31455954" role="paragraph" xml-lang="en-US"><variable id="err954">954 Variable expected</variable></paragraph> -<paragraph id="par_id31455955" role="paragraph" xml-lang="en-US"><variable id="err955">955 Label expected</variable></paragraph> -<paragraph id="par_id31455956" role="paragraph" xml-lang="en-US"><variable id="err956">956 Value cannot be applied</variable></paragraph> -<paragraph id="par_id31455957" role="paragraph" xml-lang="en-US"><variable id="err957">957 Variable already defined</variable></paragraph> -<paragraph id="par_id31455958" role="paragraph" xml-lang="en-US"><variable id="err958">958 Sub procedure or function procedure already defined</variable></paragraph> -<paragraph id="par_id31455959" role="paragraph" xml-lang="en-US"><variable id="err959">959 Label already defined</variable></paragraph> -<paragraph id="par_id31455960" role="paragraph" xml-lang="en-US"><variable id="err960">960 Variable not found</variable></paragraph> -<paragraph id="par_id31455961" role="paragraph" xml-lang="en-US"><variable id="err961">961 Array or procedure not found</variable></paragraph> -<paragraph id="par_id31455962" role="paragraph" xml-lang="en-US"><variable id="err962">962 Procedure not found</variable></paragraph> -<paragraph id="par_id31455963" role="paragraph" xml-lang="en-US"><variable id="err963">963 Label undefined</variable></paragraph> -<paragraph id="par_id31455964" role="paragraph" xml-lang="en-US"><variable id="err964">964 Unknown data type</variable></paragraph> -<paragraph id="par_id31455965" role="paragraph" xml-lang="en-US"><variable id="err965">965 Exit expected</variable></paragraph> -<paragraph id="par_id31455966" role="paragraph" xml-lang="en-US"><variable id="err966">966 Statement block still open: missing</variable></paragraph> -<paragraph id="par_id31455967" role="paragraph" xml-lang="en-US"><variable id="err967">967 Parentheses do not match</variable></paragraph> -<paragraph id="par_id31455968" role="paragraph" xml-lang="en-US"><variable id="err968">968 Symbol already defined differently</variable></paragraph> -<paragraph id="par_id31455969" role="paragraph" xml-lang="en-US"><variable id="err969">969 Parameters do not correspond to procedure</variable></paragraph> -<paragraph id="par_id31455970" role="paragraph" xml-lang="en-US"><variable id="err970">970 Invalid character in number</variable></paragraph> -<paragraph id="par_id31455971" role="paragraph" xml-lang="en-US"><variable id="err971">971 Array must be dimensioned</variable></paragraph> -<paragraph id="par_id31455972" role="paragraph" xml-lang="en-US"><variable id="err972">972 Else/Endif without If</variable></paragraph> -<paragraph id="par_id31455973" role="paragraph" xml-lang="en-US"><variable id="err973">973 not allowed within a procedure</variable></paragraph> -<paragraph id="par_id31455974" role="paragraph" xml-lang="en-US"><variable id="err974">974 not allowed outside a procedure</variable></paragraph> -<paragraph id="par_id31455975" role="paragraph" xml-lang="en-US"><variable id="err975">975 Dimension specifications do not match</variable></paragraph> -<paragraph id="par_id31455976" role="paragraph" xml-lang="en-US"><variable id="err976">976 Unknown option:</variable></paragraph> -<paragraph id="par_id31455977" role="paragraph" xml-lang="en-US"><variable id="err977">977 Constant redefined</variable></paragraph> -<paragraph id="par_id31455978" role="paragraph" xml-lang="en-US"><variable id="err978">978 Program too large</variable></paragraph> -<paragraph id="par_id31455979" role="paragraph" xml-lang="en-US"><variable id="err979">979 Strings or arrays not permitted</variable></paragraph> -<paragraph id="par_id31455980" role="paragraph" xml-lang="en-US"><variable id="err1000">1000 Object does not have this property</variable></paragraph> -<paragraph id="par_id31455981" role="paragraph" xml-lang="en-US"><variable id="err1001">1001 Object does not have this method</variable></paragraph> -<paragraph id="par_id31455982" role="paragraph" xml-lang="en-US"><variable id="err1002">1002 Required argument lacking</variable></paragraph> -<paragraph id="par_id31455983" role="paragraph" xml-lang="en-US"><variable id="err1003">1003 Invalid number of arguments</variable></paragraph> -<paragraph id="par_id31455984" role="paragraph" xml-lang="en-US"><variable id="err1004">1004 Error executing a method</variable></paragraph> -<paragraph id="par_id31455985" role="paragraph" xml-lang="en-US"><variable id="err1005">1005 Unable to set property</variable></paragraph> -<paragraph id="par_id31455986" role="paragraph" xml-lang="en-US"><variable id="err1006">1006 Unable to determine property</variable></paragraph> +<paragraph id="par_id315509599" role="paragraph"><variable id="err1">1 An exception occurred</variable></paragraph> +<paragraph id="par_id3155095" role="paragraph"><variable id="err2">2 Syntax error</variable></paragraph> +<paragraph id="par_id3149126" role="paragraph"><variable id="err3">3 Return without Gosub</variable></paragraph> +<paragraph id="par_id3153976" role="paragraph"><variable id="err4">4 Incorrect entry; please retry</variable></paragraph> +<paragraph id="par_id3150891" role="paragraph"><variable id="err5">5 Invalid procedure call</variable></paragraph> +<paragraph id="par_id3159227" role="paragraph"><variable id="err6">6 Overflow</variable></paragraph> +<paragraph id="par_id3154649" role="paragraph"><variable id="err7">7 Not enough memory</variable></paragraph> +<paragraph id="par_id3150050" role="paragraph"><variable id="err8">8 Array already dimensioned</variable></paragraph> +<paragraph id="par_id3148900" role="paragraph"><variable id="err9">9 Index out of defined range</variable></paragraph> +<paragraph id="par_id3153806" role="paragraph"><variable id="err10">10 Duplicate definition</variable></paragraph> +<paragraph id="par_id3146963" role="paragraph"><variable id="err11">11 Division by zero</variable></paragraph> +<paragraph id="par_id3153013" role="paragraph"><variable id="err12">12 Variable not defined</variable></paragraph> +<paragraph id="par_id3155593" role="paragraph"><variable id="err13">13 Data type mismatch</variable></paragraph> +<paragraph id="par_id3151197" role="paragraph"><variable id="err14">14 Invalid parameter</variable></paragraph> +<paragraph id="par_id3154710" role="paragraph"><variable id="err18">18 Process interrupted by user</variable></paragraph> +<paragraph id="par_id3147504" role="paragraph"><variable id="err20">20 Resume without error</variable></paragraph> +<paragraph id="par_id3145319" role="paragraph"><variable id="err28">28 Not enough stack memory</variable></paragraph> +<paragraph id="par_id3146110" role="paragraph"><variable id="err35">35 Sub-procedure or function procedure not defined</variable></paragraph> +<paragraph id="par_id3147246" role="paragraph"><variable id="err48">48 Error loading DLL file</variable></paragraph> +<paragraph id="par_id3146101" role="paragraph"><variable id="err49">49 Wrong DLL call convention</variable></paragraph> +<paragraph id="par_id3153957" role="paragraph"><variable id="err51">51 Internal error</variable></paragraph> +<paragraph id="par_id3154404" role="paragraph"><variable id="err52">52 Invalid file name or file number</variable></paragraph> +<paragraph id="par_id3151338" role="paragraph"><variable id="err53">53 File not found</variable></paragraph> +<paragraph id="par_id3147298" role="paragraph"><variable id="err54">54 Incorrect file mode</variable></paragraph> +<paragraph id="par_id3148747" role="paragraph"><variable id="err55">55 File already open</variable></paragraph> +<paragraph id="par_id3145233" role="paragraph"><variable id="err57">57 Device I/O error</variable></paragraph> +<paragraph id="par_id3156399" role="paragraph"><variable id="err58">58 File already exists</variable></paragraph> +<paragraph id="par_id3149324" role="paragraph"><variable id="err59">59 Incorrect record length</variable></paragraph> +<paragraph id="par_id3147409" role="paragraph"><variable id="err61">61 Disk or hard drive full</variable></paragraph> +<paragraph id="par_id3149146" role="paragraph"><variable id="err62">62 Reading exceeds EOF</variable></paragraph> +<paragraph id="par_id3150456" role="paragraph"><variable id="err63">63 Incorrect record number</variable></paragraph> +<paragraph id="par_id3146883" role="paragraph"><variable id="err67">67 Too many files</variable></paragraph> +<paragraph id="par_id3146818" role="paragraph"><variable id="err68">68 Device not available</variable></paragraph> +<paragraph id="par_id3145225" role="paragraph"><variable id="err70">70 Access denied</variable></paragraph> +<paragraph id="par_id3150372" role="paragraph"><variable id="err71">71 Disk not ready</variable></paragraph> +<paragraph id="par_id3148894" role="paragraph"><variable id="err73">73 Not implemented</variable></paragraph> +<paragraph id="par_id3152981" role="paragraph"><variable id="err74">74 Renaming on different drives impossible</variable></paragraph> +<paragraph id="par_id3149355" role="paragraph"><variable id="err75">75 Path/file access error</variable></paragraph> +<paragraph id="par_id3150477" role="paragraph"><variable id="err76">76 Path not found</variable></paragraph> +<paragraph id="par_id3154678" role="paragraph"><variable id="err91">91 Object variable not set</variable></paragraph> +<paragraph id="par_id3149890" role="paragraph"><variable id="err93">93 Invalid string pattern</variable></paragraph> +<paragraph id="par_id3146942" role="paragraph"><variable id="err94">94 Use of zero not permitted</variable></paragraph> +<paragraph id="par_id31469429" role="paragraph"><variable id="err250">250 DDE Error</variable></paragraph> +<paragraph id="par_id31469428" role="paragraph"><variable id="err280">280 Awaiting response to DDE connection</variable></paragraph> +<paragraph id="par_id31469427" role="paragraph"><variable id="err281">281 No DDE channels available</variable></paragraph> +<paragraph id="par_id31469426" role="paragraph"><variable id="err282">282 No application responded to DDE connect initiation</variable></paragraph> +<paragraph id="par_id31469425" role="paragraph"><variable id="err283">283 Too many applications responded to DDE connect initiation</variable></paragraph> +<paragraph id="par_id31469424" role="paragraph"><variable id="err284">284 DDE channel locked</variable></paragraph> +<paragraph id="par_id31469423" role="paragraph"><variable id="err285">285 External application cannot execute DDE operation</variable></paragraph> +<paragraph id="par_id31469422" role="paragraph"><variable id="err286">286 Timeout while waiting for DDE response</variable></paragraph> +<paragraph id="par_id31469421" role="paragraph"><variable id="err287">287 user pressed ESCAPE during DDE operation</variable></paragraph> +<paragraph id="par_id31469420" role="paragraph"><variable id="err288">288 External application busy</variable></paragraph> +<paragraph id="par_id31469419" role="paragraph"><variable id="err289">289 DDE operation without data</variable></paragraph> +<paragraph id="par_id31469418" role="paragraph"><variable id="err290">290 Data are in wrong format</variable></paragraph> +<paragraph id="par_id31469417" role="paragraph"><variable id="err291">291 External application has been terminated</variable></paragraph> +<paragraph id="par_id31469416" role="paragraph"><variable id="err292">292 DDE connection interrupted or modified</variable></paragraph> +<paragraph id="par_id31469415" role="paragraph"><variable id="err293">293 DDE method invoked with no channel open</variable></paragraph> +<paragraph id="par_id31469414" role="paragraph"><variable id="err294">294 Invalid DDE link format</variable></paragraph> +<paragraph id="par_id31469413" role="paragraph"><variable id="err295">295 DDE message has been lost</variable></paragraph> +<paragraph id="par_id31469412" role="paragraph"><variable id="err296">296 Paste link already performed</variable></paragraph> +<paragraph id="par_id31469411" role="paragraph"><variable id="err297">297 Link mode cannot be set due to invalid link topic</variable></paragraph> +<paragraph id="par_id31469410" role="paragraph"><variable id="err298">298 DDE requires the DDEML.DLL file</variable></paragraph> +<paragraph id="par_id3150028" role="paragraph"><variable id="err323">323 Module cannot be loaded; invalid format</variable></paragraph> +<paragraph id="par_id3148434" role="paragraph"><variable id="err341">341 Invalid object index</variable></paragraph> +<paragraph id="par_id3143219" role="paragraph"><variable id="err366">366 Object is not available</variable></paragraph> +<paragraph id="par_id3144744" role="paragraph"><variable id="err380">380 Incorrect property value</variable></paragraph> +<paragraph id="par_id3147420" role="paragraph"><variable id="err382">382 This property is read-only</variable></paragraph> +<paragraph id="par_id3147472" role="paragraph"><variable id="err394">394 This property is write-only</variable></paragraph> +<paragraph id="par_id3148583" role="paragraph"><variable id="err420">420 Invalid object reference</variable></paragraph> +<paragraph id="par_id3153329" role="paragraph"><variable id="err423">423 Property or method not found</variable></paragraph> +<paragraph id="par_id3148738" role="paragraph"><variable id="err424">424 Object required</variable></paragraph> +<paragraph id="par_id3159084" role="paragraph"><variable id="err425">425 Invalid use of an object</variable></paragraph> +<paragraph id="par_id3146806" role="paragraph"><variable id="err430">430 OLE Automation is not supported by this object</variable></paragraph> +<paragraph id="par_id3146130" role="paragraph"><variable id="err438">438 This property or method is not supported by the object</variable></paragraph> +<paragraph id="par_id3154374" role="paragraph"><variable id="err440">440 OLE automation error</variable></paragraph> +<paragraph id="par_id3149685" role="paragraph"><variable id="err445">445 This action is not supported by given object</variable></paragraph> +<paragraph id="par_id3150282" role="paragraph"><variable id="err446">446 Named arguments are not supported by given object</variable></paragraph> +<paragraph id="par_id3150142" role="paragraph"><variable id="err447">447 The current locale setting is not supported by the given object</variable></paragraph> +<paragraph id="par_id3152771" role="paragraph"><variable id="err448">448 Named argument not found</variable></paragraph> +<paragraph id="par_id3145145" role="paragraph"><variable id="err449">449 Argument is not optional</variable></paragraph> +<paragraph id="par_id3154399" role="paragraph"><variable id="err450">450 Invalid number of arguments</variable></paragraph> +<paragraph id="par_id3146137" role="paragraph"><variable id="err451">451 Object is not a list</variable></paragraph> +<paragraph id="par_id3149507" role="paragraph"><variable id="err452">452 Invalid ordinal number</variable></paragraph> +<paragraph id="par_id3154566" role="paragraph"><variable id="err453">453 Specified DLL function not found</variable></paragraph> +<paragraph id="par_id3145595" role="paragraph"><variable id="err460">460 Invalid clipboard format</variable></paragraph> +<paragraph id="par_id31455951" role="paragraph"><variable id="err951">951 Unexpected symbol:</variable></paragraph> +<paragraph id="par_id31455952" role="paragraph"><variable id="err952">952 Expected:</variable></paragraph> +<paragraph id="par_id31455953" role="paragraph"><variable id="err953">953 Symbol expected</variable></paragraph> +<paragraph id="par_id31455954" role="paragraph"><variable id="err954">954 Variable expected</variable></paragraph> +<paragraph id="par_id31455955" role="paragraph"><variable id="err955">955 Label expected</variable></paragraph> +<paragraph id="par_id31455956" role="paragraph"><variable id="err956">956 Value cannot be applied</variable></paragraph> +<paragraph id="par_id31455957" role="paragraph"><variable id="err957">957 Variable already defined</variable></paragraph> +<paragraph id="par_id31455958" role="paragraph"><variable id="err958">958 Sub procedure or function procedure already defined</variable></paragraph> +<paragraph id="par_id31455959" role="paragraph"><variable id="err959">959 Label already defined</variable></paragraph> +<paragraph id="par_id31455960" role="paragraph"><variable id="err960">960 Variable not found</variable></paragraph> +<paragraph id="par_id31455961" role="paragraph"><variable id="err961">961 Array or procedure not found</variable></paragraph> +<paragraph id="par_id31455962" role="paragraph"><variable id="err962">962 Procedure not found</variable></paragraph> +<paragraph id="par_id31455963" role="paragraph"><variable id="err963">963 Label undefined</variable></paragraph> +<paragraph id="par_id31455964" role="paragraph"><variable id="err964">964 Unknown data type</variable></paragraph> +<paragraph id="par_id31455965" role="paragraph"><variable id="err965">965 Exit expected</variable></paragraph> +<paragraph id="par_id31455966" role="paragraph"><variable id="err966">966 Statement block still open: missing</variable></paragraph> +<paragraph id="par_id31455967" role="paragraph"><variable id="err967">967 Parentheses do not match</variable></paragraph> +<paragraph id="par_id31455968" role="paragraph"><variable id="err968">968 Symbol already defined differently</variable></paragraph> +<paragraph id="par_id31455969" role="paragraph"><variable id="err969">969 Parameters do not correspond to procedure</variable></paragraph> +<paragraph id="par_id31455970" role="paragraph"><variable id="err970">970 Invalid character in number</variable></paragraph> +<paragraph id="par_id31455971" role="paragraph"><variable id="err971">971 Array must be dimensioned</variable></paragraph> +<paragraph id="par_id31455972" role="paragraph"><variable id="err972">972 Else/Endif without If</variable></paragraph> +<paragraph id="par_id31455973" role="paragraph"><variable id="err973">973 not allowed within a procedure</variable></paragraph> +<paragraph id="par_id31455974" role="paragraph"><variable id="err974">974 not allowed outside a procedure</variable></paragraph> +<paragraph id="par_id31455975" role="paragraph"><variable id="err975">975 Dimension specifications do not match</variable></paragraph> +<paragraph id="par_id31455976" role="paragraph"><variable id="err976">976 Unknown option:</variable></paragraph> +<paragraph id="par_id31455977" role="paragraph"><variable id="err977">977 Constant redefined</variable></paragraph> +<paragraph id="par_id31455978" role="paragraph"><variable id="err978">978 Program too large</variable></paragraph> +<paragraph id="par_id31455979" role="paragraph"><variable id="err979">979 Strings or arrays not permitted</variable></paragraph> +<paragraph id="par_id31455980" role="paragraph"><variable id="err1000">1000 Object does not have this property</variable></paragraph> +<paragraph id="par_id31455981" role="paragraph"><variable id="err1001">1001 Object does not have this method</variable></paragraph> +<paragraph id="par_id31455982" role="paragraph"><variable id="err1002">1002 Required argument lacking</variable></paragraph> +<paragraph id="par_id31455983" role="paragraph"><variable id="err1003">1003 Invalid number of arguments</variable></paragraph> +<paragraph id="par_id31455984" role="paragraph"><variable id="err1004">1004 Error executing a method</variable></paragraph> +<paragraph id="par_id31455985" role="paragraph"><variable id="err1005">1005 Unable to set property</variable></paragraph> +<paragraph id="par_id31455986" role="paragraph"><variable id="err1006">1006 Unable to determine property</variable></paragraph> </section> </body> </helpdocument> diff --git a/source/text/sbasic/shared/03104400.xhp b/source/text/sbasic/shared/03104400.xhp index 03ae66bf84..4c26846992 100644 --- a/source/text/sbasic/shared/03104400.xhp +++ b/source/text/sbasic/shared/03104400.xhp @@ -1,5 +1,4 @@ <?xml version="1.0" encoding="UTF-8"?> - <!-- * This file is part of the LibreOffice project. * @@ -17,11 +16,10 @@ * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . --> - <helpdocument version="1.0"> <meta> <topic id="textsbasicshared03104400xml" indexer="include" status="PUBLISH"> -<title id="tit" xml-lang="en-US">HasUnoInterfaces Function</title> +<title id="tit">HasUnoInterfaces Function</title> <filename>/text/sbasic/shared/03104400.xhp</filename> </topic> <history> @@ -30,24 +28,61 @@ </meta> <body> <section id="hasunointerfaces"> -<bookmark xml-lang="en-US" branch="index" id="bm_id3149987"><bookmark_value>HasUnoInterfaces function</bookmark_value> +<bookmark branch="index" id="bm_id3149987"><bookmark_value>HasUnoInterfaces function</bookmark_value> </bookmark> <h1 id="hd_id3149987"><link href="text/sbasic/shared/03104400.xhp">HasUnoInterfaces Function</link></h1> -<paragraph role="paragraph" id="par_id3151262" xml-lang="en-US">Tests if a Basic Uno object supports certain Uno interfaces.</paragraph> +<paragraph role="paragraph" id="par_id3151262">Tests if a Basic Uno object supports certain Uno interfaces.</paragraph> </section> -<paragraph role="paragraph" id="par_id3154232" xml-lang="en-US">Returns True, if <emph>all</emph> stated Uno interfaces are supported, otherwise False is returned.</paragraph> +<paragraph role="paragraph" id="par_id3154232">Returns True, if <emph>all</emph> stated Uno interfaces are supported, otherwise False is returned.</paragraph> <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> -<paragraph role="code" id="par_id3155555" xml-lang="en-US">HasUnoInterfaces( oTest, Uno-Interface-Name 1 [, Uno-Interface-Name 2, ...])</paragraph> +<paragraph role="code" id="par_id3155555">HasUnoInterfaces( oTest, Uno-Interface-Name 1 [, Uno-Interface-Name 2, ...])</paragraph> <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> <paragraph role="paragraph" localize="false" id="par_id3148538">Bool</paragraph> <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> -<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US"> -<emph>oTest:</emph> the Basic Uno object that you want to test.</paragraph> -<paragraph role="paragraph" id="par_id3149236" xml-lang="en-US"> -<emph>Uno-Interface-Name:</emph> list of Uno interface names.</paragraph> +<table id="tab_id951744656264278"> + <tablerow> + <tablecell> + <paragraph id="par_id641744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_name" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id511744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_type" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421744656264278" role="tablehead" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_desc" markup="ignore"/></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471744656264278" role="tablecontent">oTest</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id481744656264278" role="tablecontent" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id801744656264278" role="tablecontent">the Basic Uno object that you want to test.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311744656367084" role="tablecontent">Uno-Interface-Name 1, <br/>Uno-Interface-Name 2, ...</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701744656380892" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201744656388588" role="tablecontent">Uno interface name(s)</paragraph> + </tablecell> + </tablerow> +</table> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> <bascode> - <paragraph role="bascode" localize="false" id="par_id3149580" xml-lang="en-US">bHas = HasUnoInterfaces( oTest, "com.sun.star.beans.XIntrospection" )</paragraph> +<paragraph role="bascode" id="par_id841744649856206" localize="false">Sub HasInterface</paragraph> +<paragraph role="bascode" id="par_id181744649817277" localize="false"> Dim bHas as Boolean</paragraph> +<paragraph role="bascode" id="par_id1001744649828319" localize="false"> Dim oSheet as Object</paragraph> +<paragraph role="bascode" id="par_id511744649836503" localize="false"> oSheet = ThisComponent.Sheets(0) </paragraph> +<paragraph role="bascode" localize="false" id="par_id3149580"> bHas = HasUnoInterfaces( oSheet, "com.sun.star.beans.XIntrospection" )</paragraph> +<paragraph role="bascode" id="par_id741744649843190" localize="false"> Print bHas ' = True</paragraph> +<paragraph role="bascode" id="par_id41744649848326" localize="false">End Sub</paragraph> </bascode> </body> </helpdocument>