1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3226a8927SAndrew Rist<!--***********************************************************
4*923b75a4Smseidel *
5226a8927SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
6226a8927SAndrew Rist * or more contributor license agreements.  See the NOTICE file
7226a8927SAndrew Rist * distributed with this work for additional information
8226a8927SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
9226a8927SAndrew Rist * to you under the Apache License, Version 2.0 (the
10226a8927SAndrew Rist * "License"); you may not use this file except in compliance
11226a8927SAndrew Rist * with the License.  You may obtain a copy of the License at
12*923b75a4Smseidel *
13226a8927SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
14*923b75a4Smseidel *
15226a8927SAndrew Rist * Unless required by applicable law or agreed to in writing,
16226a8927SAndrew Rist * software distributed under the License is distributed on an
17226a8927SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18226a8927SAndrew Rist * KIND, either express or implied.  See the License for the
19226a8927SAndrew Rist * specific language governing permissions and limitations
20226a8927SAndrew Rist * under the License.
21*923b75a4Smseidel *
22226a8927SAndrew Rist ***********************************************************-->
23226a8927SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03132300xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">CreateUnoValue Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03132300.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="createunovalue">
33cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3150682"><bookmark_value>CreateUnoValue function</bookmark_value>
34cdf0e10cSrcweir</bookmark>
35cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150682" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03132300.xhp" name="CreateUnoValue Function [Runtime]">CreateUnoValue Function [Runtime]</link></paragraph>
36cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147291" xml-lang="en-US" l10n="U" oldref="2">Returns an object that represents a strictly typed value referring to the Uno type system. </paragraph>
37cdf0e10cSrcweir</section>
38cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3143267" xml-lang="en-US" l10n="U" oldref="3">This object is automatically converted to an Any of the corresponding type when passed to Uno. The type must be specified by its fully qualified Uno type name.</paragraph>
39cdf0e10cSrcweir<paragraph role="note" id="par_id3153626" xml-lang="en-US" l10n="U" oldref="4">The $[officename] API frequently uses the Any type. It is the counterpart of the Variant type known from other environments. The Any type holds one arbitrary Uno type and is used in generic Uno interfaces.</paragraph>
40cdf0e10cSrcweir<paragraph role="heading" id="hd_id3147560" xml-lang="en-US" level="2" l10n="U" oldref="5">Syntax:</paragraph>
41cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154760" xml-lang="en-US" l10n="U" oldref="6">oUnoValue = CreateUnoValue( "[]byte", MyBasicValue ) to get a byte sequence.</paragraph>
42cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150541" xml-lang="en-US" l10n="U" oldref="7">If CreateUnoValue cannot be converted to the specified Uno type, and error occurs. For the conversion, the TypeConverter service is used.</paragraph>
43cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153524" xml-lang="en-US" l10n="U" oldref="8">This function is intended for use in situations where the default Basic to Uno type converting mechanism is insufficient. This can happen when you try to access generic Any based interfaces, such as XPropertySet::setPropertyValue( Name, Value ) or X???Container::insertBy???( ???, Value ), from $[officename] Basic. The Basic runtime does not recognize these types as they are only defined in the corresponding service.</paragraph>
44cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154366" xml-lang="en-US" l10n="U" oldref="9">In this type of situation, $[officename] Basic chooses the best matching type for the Basic type that you want to convert. However, if the wrong type is selected, an error occurs. You use the CreateUnoValue() function to create a value for the unknown Uno type.</paragraph>
45cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3150769" xml-lang="en-US" l10n="U" oldref="10">You can also use this function to pass non-Any values, but this is not recommend. If Basic already knows the target type, using the CreateUnoValue() function will only lead to additional converting operations that slow down the Basic execution.</paragraph>
46cdf0e10cSrcweir</body>
47cdf0e10cSrcweir</helpdocument>
48