1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_plink_get_option">
<refmeta>
<refentrytitle>BPEL.BPEL.plink_get_option</refentrytitle>
<refmiscinfo>bpel</refmiscinfo>
</refmeta>
<refnamediv>
<refname>BPEL.BPEL.plink_get_option</refname>
<refpurpose>retrieving a partner link option</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_plink_get_option">
<funcprototype id="fproto_plink_get_option">
<funcdef><function>BPEL.BPEL.plink_get_option</function></funcdef>
<paramdef>in <parameter>script</parameter> varchar</paramdef>
<paramdef>in <parameter>plink</parameter> varchar</paramdef>
<paramdef>in <parameter>opt</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="params_get_var"><title>Parameters</title>
<refsect2><title>script</title>
<para><type>varchar</type> name of a process that partner link belongs to</para>
</refsect2>
<refsect2><title>plink</title>
<para><type>varchar</type> name of the partner link</para>
</refsect2>
<refsect2><title>opt</title>
<para><type>varchar</type> name of the options to be retrieved</para>
</refsect2>
</refsect1>
<refsect1 id="ret_plink_get_option"><title>Return Types</title>
<para>
The function returns a string or array of strings depending of the
requested option.
</para>
</refsect1>
<refsect1 id="desc_plink_get_option">
<title>Description</title>
<para><function>BPEL.BPEL.plink_get_option</function>
<para>
This function can be used to retrieve the options assigned to a
particular partner link.
These options are used to configure various Web Service
protocols (see Protocol Support section in BPEL reference chapter).
</para>
<para>
For available options see <link linkend="fn_plink_set_option"><function>plink_set_option()</function></link> function.
</para>
</para>
</refsect1>
<refsect1 id="examples_plink_get_option"><title>Examples</title>
<example id="ex_plink_get_option"><title>Simple example</title>
<screen><![CDATA[
SQL> select BPEL.BPEL.plink_get_option ('WSSecho', 'service', 'wss-in-encrypt');
callret
VARCHAR
_______________________________________________________________________________
NONE
]]></screen>
</example>
</refsect1>
</refentry>
|
