m204wiki - User contributions [en]

$Tan

2012-01-04T20:28:44Z

198.242.244.47: Created page with " Tangent Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct OO equ..."

Tangent
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$Tan</var> function.
[[Category: Mathematical $functions]]



The <var>$Tan</var> function returns
the tangent of an argument that is given in radians.
If the magnitude of the argument exceeds 10&'sup(15) radians, an error
message is printed and a 0 is returned.

==Syntax==
%num = $Tan(x) 

{{Template:Math $functions note}}

$Sqrt

2012-01-04T20:28:44Z

198.242.244.47: Created page with " Square root Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>..."

Square root
Most Sirius $functions have been deprecated in favor of Object Oriented
methods.
The OO equivalent for the
<var>$Sqrt</var>
function is the <var>[[SquareRoot (Float function)|SquareRoot]]</var> function.
[[Category: Mathematical $functions]]



The <var>$Sqrt</var> function returns
the value of the square root of the given argument.
If the argument is negative, an error message is
printed and a 0 is returned.

==Syntax==
%num = $Sqrt(x) 

{{Template:Math $functions note}}

$SinH

2012-01-04T20:28:43Z

198.242.244.47: Created page with " Hyperbolic sine Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direc..."

Hyperbolic sine
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$SinH</var> function.
[[Category: Mathematical $functions]]



The <var>$SinH</var> function returns
the hyperbolic sine of an argument that is given in radians.
If the magnitude of the argument exceeds 175.366, an error message is
printed and a 0 is returned.

==Syntax==
%num = $SinH(x) 

{{Template:Math $functions note}}

$Sin

2012-01-04T20:28:43Z

198.242.244.47: Created page with " Sine Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct OO equiva..."

Sine
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$Sin</var> function.
[[Category: Mathematical $functions]]



The <var>$Sin</var> function returns
the sine of an argument that is given in radians.
If the magnitude of the argument exceeds 10&'sup(15) radians, an error
message is printed and a 0 is returned.

==Syntax==
%num = $Sin(x) 

{{Template:Math $functions note}}

$RxpR

2012-01-04T20:28:43Z

198.242.244.47: Created page with " Real base raised to real exponent Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is ..."

Real base raised to real exponent
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$RxPR</var> function.
[[Category: Mathematical $functions]]



The <var>$RxPR</var> function returns the value of its first
argument raised to the power of its second argument.

==Syntax==
%num = $RxPR(x) 

If either of the following is true,
an error message is printed and a 0 is returned:
<ul>
<li>''x'' is less than zero.
<li>''x'' equals 0, and ''y'' is less than or equal to 0.
</ul>

For example:
 $RXPR(9, 2) = 9&'sup(2) = 81

$RXPR(64, .5) = 8

$RXPR(256, .25) = 4


{{Template:Math $functions note}}

$RxpI

2012-01-04T20:28:43Z

198.242.244.47: Created page with " Real base raised to integer exponent Most Sirius $functions have been deprecated in favor of Object Oriented methods. There ..."

Real base raised to integer exponent
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$RxPI</var> function.
[[Category: Mathematical $functions]]



The <var>$RxPI</var> function returns the value of its first
argument raised to the power of its second argument.
The second argument is initially rounded to the nearest
integral value.

==Syntax==
%num = $RxPI(x) 

Omitted arguments are set to 0.
If ''x'' equals 0, and |''y''| is less
than or equal to 0, an error message is printed and a 0 is returned.

For example:
 $RXPI(2, 3) = 2&'sup(3) = 8

$RXPI(.5, 1.4) = $RXPI(.5, 1) = .5


{{Template:Math $functions note}}

$Pi

2012-01-04T20:28:42Z

198.242.244.47: Created page with " Value of pi Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct OO..."

Value of pi
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$Pi</var> function.
[[Category: Mathematical $functions]]



The <var>$Pi</var> function returns the value of pi (<code>&pi.</code>) to 15 significant
digits (3.14159265358979).

==Syntax==
%num = $Pi 

{{Template:Math $functions note}}

$Log10 or $Log 10

2012-01-04T20:28:42Z

198.242.244.47: Created page with " Log base 10 function Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for ..."

Log base 10 function
Most Sirius $functions have been deprecated in favor of Object Oriented
methods.
The OO equivalent for the
<var>$Log10</var>
function is the <var>[[Log10 (Float function)|Log10]]</var> function.
[[Category: Mathematical $functions]]



The <var>$Log10</var> function returns the base-10 logarithm
of the number ''x''.

==Syntax==
%num = $Log10(x) 

If ''x'' is not greater than 0,
an error message is printed and a 0 is returned.

{{Template:Math $functions note}}

$Log2 or $Log 2

2012-01-04T20:28:41Z

198.242.244.47: Created page with " Log base 2 function Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for t..."

Log base 2 function
Most Sirius $functions have been deprecated in favor of Object Oriented
methods.
The OO equivalent for the
<var>$Log2</var>
function is the <var>[[Log2 (Float function)|Log2]]</var> function.
[[Category: Mathematical $functions]]



The <var>$Log2</var> function returns the base-2 logarithm
of the number ''x''.

==Syntax==
%num = $Log2(x) 

If ''x'' is not greater than 0,
an error message is printed and a 0 is returned.

{{Template:Math $functions note}}

$Log or $Log e

2012-01-04T20:28:41Z

198.242.244.47: Created page with " Log function Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var..."

Log function
Most Sirius $functions have been deprecated in favor of Object Oriented
methods.
The OO equivalent for the
<var>$Log</var>
function is the <var>[[LogE (Float function)|LogE]]</var> function.
[[Category: Mathematical $functions]]



The <var>$Log</var> function returns the natural logarithm
(the logarithm base e) of the number ''x''.

==Syntax==
%num = $Log(x) 

If ''x'' is not greater than 0,
an error message is printed and a 0 is returned.

{{Template:Math $functions note}}

$LGamma

2012-01-04T20:28:41Z

198.242.244.47: Created page with " LGamma function Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direc..."

LGamma function
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$LGamma</var> function.
[[Category: Mathematical $functions]]



The <var>$LGamma</var> function returns the value:
:hp0 font=chapn.
<ul>
<li> &numsp.&'sub(&infin.)
 
log&'sub(e) &'sub(0)&int. u&'sup( x-1) e&'sup( - u) du
</ul>
:ehp0.

==Syntax==
%num = $LGamma(x) 

If ''x'' is not in the range 0 < ''x'' < 4.2913 * 10&'sup(73),
an error message is printed and a 0 is returned.

{{Template:Math $functions note}}

$IxpI

2012-01-04T20:28:40Z

198.242.244.47: Created page with " Integer base raised to integer exponent Most Sirius $functions have been deprecated in favor of Object Oriented methods. The..."

Integer base raised to integer exponent
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$IxPI</var> function.
[[Category: Mathematical $functions]]



The <var>$IxPI</var> function returns the value of
its first argument (rounded to the nearest integral
value) raised to the power of its second argument (rounded to the nearest
integral value).
If |''x''| equals 0, and |''y''| is less
than or equal to 0, an error message is printed and a 0 is returned.

==Syntax==
%num = $IxPI(x) 

For example:
 $IXPI(8,2) = 8&'sup(2) = 64

$IXPI(2.4,.5) = $IXPI(2,1) = 2


{{Template:Math $functions note}}

$Gamma

2012-01-04T20:28:40Z

198.242.244.47: Created page with " Gamma function Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct..."

Gamma function
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$Gamma</var> function.
[[Category: Mathematical $functions]]



The <var>$Gamma</var> function returns the value:
:hp0 font=chapn.
<ul>
<li> &'sub(&infin.)
 
&'sub(0)&int. u&'sup( x-1) e&'sup( - u) du
</ul>
:ehp0.

==Syntax==
%num = $Gamma(x) 

If ''x'' is not within the range 0 < ''x'' < 57.5744,
an error message is printed and a
0 is returned.

{{Template:Math $functions note}}

$Exp10 or $Exp 10

2012-01-04T20:28:40Z

198.242.244.47: Created page with " Ten's exponent function Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent f..."

Ten's exponent function
Most Sirius $functions have been deprecated in favor of Object Oriented
methods.
The OO equivalent for the
<var>$Exp10</var>
function is the <var>[[Antilog10 (Float function)|Antilog10]]</var> function.
[[Category: Mathematical $functions]]



The <var>$Exp10</var> function returns the
value <code>10&'sup(x)</code>.

==Syntax==
%num = $Exp10(x) 

{{Template:Math $functions note}}

$Exp2 or $Exp 2

2012-01-04T20:28:40Z

198.242.244.47: Created page with " Two's exponent function Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent f..."

Two's exponent function
Most Sirius $functions have been deprecated in favor of Object Oriented
methods.
The OO equivalent for the
<var>$Exp2</var>
function is the <var>[[Antilog2 (Float function)|Antilog2]]</var> function.
[[Category: Mathematical $functions]]



The <var>$Exp2</var> function returns the
value <code>2&'sup(x)</code>.

==Syntax==
%num = $Exp2(x) 

{{Template:Math $functions note}}

$Exp or $Exp e

2012-01-04T20:28:39Z

198.242.244.47: Created page with " Exponential function Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for ..."

Exponential function
Most Sirius $functions have been deprecated in favor of Object Oriented
methods.
The OO equivalent for the
<var>$Exp</var>
function is the <var>[[AntilogE (Float function)|AntilogE]]</var> function.
[[Category: Mathematical $functions]]



The <var>$Exp</var> function returns the
value <code>e&'sup(x)</code>.

==Syntax==
%num = $Exp(x) 

If ''x'' exceeds 174.63, an error message
is printed and a 0 is returned.

{{Template:Math $functions note}}

$ErfC

2012-01-04T20:28:39Z

198.242.244.47: Created page with " Error function complement Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currentl..."

Error function complement
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$ErfC</var> function.
[[Category: Mathematical $functions]]



The <var>$ErfC</var> function returns 1 - the <var>[[$Erf]]</var> value, that is:
:hp0 font=chapn.
<ul>
<li> &numsp.&'sub(x) &thinsp.&'sub(2)
 
1 &minus. 2&sol.&radic.&pi. &'sub(0)&int. &thinsp.e&'sup(-z) &thinsp.dz
</ul>
:ehp0.

==Syntax==
%num = $ErfC(x) 

{{Template:Math $functions note}}

$Erf

2012-01-04T20:28:39Z

198.242.244.47: Created page with " Error function Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct..."

Error function
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$Erf</var> function.
[[Category: Mathematical $functions]]



The <var>$Erf</var> function returns the value:
:hp0 font=chapn.
<ul>
<li> &thinsp.&'sub(x) &thinsp.&'sub(2)
 
2&sol.&radic.&pi. &'sub(0)&int. &thinsp.e&'sup(-z) &thinsp.dz
</ul>
:ehp0.

==Syntax==
%num = $Erf(x) 

{{Template:Math $functions note}}

$Cotan

2012-01-04T20:28:38Z

198.242.244.47: Created page with " Cotangent Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct OO e..."

Cotangent
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$Cotan</var> function.
[[Category: Mathematical $functions]]



The <var>$Cotan</var> function returns
the cotangent of an argument that is given in radians.
If the
magnitude of the argument exceeds 10&'sup(15) radians, an error message is
printed and a 0 is returned.

==Syntax==
%num = $Cotan(x) 

{{Template:Math $functions note}}

$CosH

2012-01-04T20:28:38Z

198.242.244.47: Created page with " Hyperbolic cosine Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no dir..."

Hyperbolic cosine
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$CosH</var> function.
[[Category: Mathematical $functions]]



The <var>$CosH</var> function returns
the hyperbolic cosine of an argument that is given in radians.
If the magnitude of the argument exceeds 175.366, an error message is printed
and a 0 is returned.

==Syntax==
%num = $CosH(x) 

{{Template:Math $functions note}}

$Cos

2012-01-04T20:28:37Z

198.242.244.47: Created page with " Cosine Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct OO equi..."

Cosine
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$Cos</var> function.
[[Category: Mathematical $functions]]



The <var>$Cos</var> function returns
the cosine of an argument that is given in radians.
If the
magnitude of the argument exceeds 10&'sup(15) radians, an error message is
printed and a 0 is returned.

==Syntax==
%num = $Cos(x) 

{{Template:Math $functions note}}

$ArcTan2

2012-01-04T20:28:37Z

198.242.244.47: Created page with " Inverse tangent of ratio of arguments Most Sirius $functions have been deprecated in favor of Object Oriented methods. There..."

Inverse tangent of ratio of arguments
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$ArcTan2</var> function.
[[Category: Mathematical $functions]]



The <var>$ArcTan2</var> function returns
the arctangent (in radians) of the ratio of two arguments
— ''x'' divided by ''y''.
If the second
argument is 0 (or omitted), an error message is printed and a 0 is returned.

==Syntax==
%num = $ArcTan2(x,y) 

{{Template:Math $functions note}}

$ArcTan

2012-01-04T20:28:37Z

198.242.244.47: Created page with " Inverse tangent Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direc..."

Inverse tangent
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$ArcTan</var> function.
[[Category: Mathematical $functions]]



The <var>$ArcTan</var> function returns
the arctangent (in radians) of a given argument.

==Syntax==
%num = $ArcTan(x) 

{{Template:Math $functions note}}

$ArcSin

2012-01-04T20:28:37Z

198.242.244.47: Created page with " Inverse sine Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct O..."

Inverse sine
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$ArcSin</var> function.
[[Category: Mathematical $functions]]



The <var>$ArcSin</var> function returns
the arcsine (in radians) of a given argument.
If the magnitude of the argument exceeds 1, an error message is printed
and a 0 is returned.

==Syntax==
%num = $ArcSin(x) 

{{Template:Math $functions note}}

$ArcCos

2012-01-04T20:28:36Z

198.242.244.47: Created page with " Inverse cosine Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct..."

Inverse cosine
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for the <var>$ArcCos</var> function.
[[Category: Mathematical $functions]]



The <var>$ArcCos</var> function returns
the arccosine (in radians) of a given argument.
If the magnitude of the argument exceeds 1, an error message is printed
and a 0 is returned.

==Syntax==
%num = $ArcCos(x) 

{{Template:Math $functions note}}

$Abs

2012-01-04T20:28:36Z

198.242.244.47: Created page with " Absolute value Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <v..."

Absolute value
Most Sirius $functions have been deprecated in favor of Object Oriented
methods.
The OO equivalent for the
<var>$Abs</var>
function is the <var>[[Absolute (Float function)|Absolute]]</var> function.

[[Category: Mathematical $functions]]



The <var>$Abs</var> function returns the absolute value of its given argument.

==Syntax==
%num = $Abs(x) 

For example:
 $ABS(-50) = 50

$ABS(6) = 6


{{Template:Math $functions note}}

URLEncode (Socket function)

2011-11-08T19:34:04Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> URLEncode function <var>URLEncode</var> is a member of the <va..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|URLEncode function]]

<var>URLEncode</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This method uses the URL "% hex hex" escape format to
encode the special characters in the string you specify.

The <var>URLEncode</var> function has an effect similar to
its equivalent $function, <var>$Sock_Url_Encode</var>.

==Syntax==
%lstr = %socko:URLEncode(string)

<table class="syntaxTable">
<tr><th>%lstr
</th><td><var>Longstring</var> that is to contain the modified, encoded version of the input string <var class="term">string</var>.
</td></tr>
<tr><th>%socko
</th><td>A variable or an expression that is a reference to a <var>Socket</var> object.
</td></tr>
<tr><th>string
</th><td>The string whose reserved characters are to be encoded using the "% hex hex" format. If this string is omitted, a null string is returned.
</td></tr></table>

==Usage notes==
<ul>
<li>The <var>Socket</var> method object (<var class="term">%socko</var>) has associated with it
the translation table used for the encoding of the special characters (see <var>[[XTAB]]</var>).
This translation table is necessary because special characters are converted
to the hexadecimal representations of their '''ASCII''' values, even
though the input and output strings are both in EBCDIC.
Data that must be encoded as hexadecimal must be translated to ASCII
first, which means that the appropriate ASCII-to-EBCDIC translation table
must be indicated to <var>URLEncode</var> via the <var>Socket</var> object.
<li><var>URLEncode</var> is particularly useful for constructing URLs, especially
when composing the query string portion of a URL (<code>http://host/path?query</code>).
<var>URLEncode</var> is also useful for composing form data for a post request over an HTTP
connection.
<li>The non-alphanumeric characters that <var>[[$Sock_Url_Encode]]</var> does not encode are these seven:
. ( ) ! $ * - _

</ul>

==Example==

In this example, <var>URLEncode</var> creates <code>%-hex-hex</code> encoding
for this browser request to an HTTP server in the HTTP Get format:
 ...
%rc = %sock:Send('GET /')
%rc = %sock:Send(%url)
%rc = %sock:Send('?info=')
%rc = %sock:Send(%sock:URLEncode(%info))
%rc = %sock:SendWithLineEnd(' HTTP/1.0')
...

For example, if <code>%info</code> contains:
10 + 3.14 * R*R*R * 2/3

The following value is sent to the web server after the <code>info=</code>:
10+%2B+3.14+*+R*R*R+*+2%2F3

<code>+</code> signifies a blank, <code>%</code> introduces a hex encoding,
<code>2B</code> is the ASCII code for a plus sign (<tt>+</tt>), and <code>2f</code> is the ASCII code for a
slash (<tt>/</tt>).

==Sample Code==
Here is a code fragment that fetches the Sirius home page using a <var>Socket</var> object.
You may want to contrast this with the $function sample in [[Sample Janus Sockets Programs#Simple echo of HTTP/HTML|"Simple echo of HTTP/HTML"]].
%socko object <var>Socket</var>
%socko = New('HTTPCLIENT', 'www.sirius-software.com', 80)
If %socko Is Null Then
Print 'Error:' And $STATUSD
Stop
End If

%socko:SendWithLineEnd('GET / HTTP/1.0')
%socko:SendWithLineEnd( '' )
%socko:Set('PRSTOK','AMBIG|0D0A|0A|0D')

Repeat While ( %socko:ReceiveAndParse(%s) )
Print %s
End Repeat

Print %(Socket):Num('RESET')
Print %(Socket):ErrInfo('CODE')
%socko:Close

TranOut (Socket function)

2011-11-08T19:34:04Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> TranOut function <var>TranOut</var> is a member of the <var>[[..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|TranOut function]]

<var>TranOut</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This method translates an individual string,
from the local internal character set (EBCDIC),
to the character set of the remote.
Designed for cases where translation needs to be selective, the <var>TranOut</var> function
has an effect similar to its equivalent $function, <var>$Sock_Tran_Out</var>.

==Syntax==
%str = %socko:TranOut(string)

<table class="syntaxTable">
<tr><th>%str
</th><td>String that is to contain the translation of the input string into the remote character set.
</td></tr>
<tr><th>%socko
</th><td>A variable or an expression that is a reference to a <var>Socket</var> object.
</td></tr>
<tr><th>string
</th><td>The string that is to be translated to the remote character set.
</td></tr></table>

==Usage notes==
<ul>
<li>The translate table <var>TranOut</var> uses is the input table
defined by the <var>[[XTAB]]</var> parameter of the socket.
<li>The <var>TranOut</var> method can cause a jump to
the <var>ONRESET</var> label or request cancellation, and it can set the last error information,
but it does not return any error indication.
<li>The <var>TranOut</var> method continues with the next statement if <code>ONRESET
CONTINUE</code>, <code>CANCELC</code>, or <code>LABELC</code> is in effect for the socket.
It always returns the translated string; it never returns an error indicator.
<li>Typically, <var>TranOut</var> is used to translate from EBCDIC
strings that are sent to non-mainframe sources that use other
character mapping schemes, like ASCII or non-English character sets.
</ul>

==Examples==
<ul>
<li>In the following example, database fields only are translated and sent to the remote.
%sock is Object <var>Socket</var>
%sock = New
%old = %sock:Set('BINARY')
For Each Record
%xlate = %sock:TranOut(DATA_FIELD)
%rc = %sock:SendWithLineEnd(%xlate)
End For
%old = %sock:Set('BINARY', %old)

<li><var>TranOut</var> can be useful if you want to use a "normal" character as either the <var>LINEND</var> or
<var>PRSTOK</var> value (see <var>[[Set (Socket function)|Set]]</var>) for communication with the remote.
In the following example, <var>LINEND</var> is set to a pair of plus sign (<tt>+</tt>) characters:
Begin
%sock is Object <var>Socket</var>
%sock = New('SOCKEM')
%s = %sock:TranOut('++')
%t = %sock:Set('LINEND', %s)
...

</ul>

TranIn (Socket function)

2011-11-08T19:34:04Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> TranIn function <var>TranIn</var> is a member of the <var>[[So..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|TranIn function]]

<var>TranIn</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This method translates an individual string,
from the character set of the remote to the local internal character set (EBCDIC).
Designed for cases where translation needs to be selective,
the <var>TranIn</var> function has an effect similar to
its equivalent $function, <var>[[$Sock_Tran_In]]</var>.

==Syntax==
%str = %socko:TranIn(string)

<table class="syntaxTable">
<tr><th>%str
</th><td>String that is to contain the translation of the input string into the local character set.
</td></tr>
<tr><th>%socko
</th><td>A variable or an expression that is a reference to a <var>Socket</var> object.
</td></tr>
<tr><th>string
</th><td>The string that is to be translated to the socket's local character set.
</td></tr></table>

==Usage notes==
<ul>
<li>The translate table <var>TranIn</var> uses is the input table
defined by the <var>[[XTAB]]</var> parameter of the socket.
<li>The <var>TranIn</var> method can cause a jump to
the <var>ONRESET</var> label or request cancellation, and it can set the last error information,
but it does not return any error indication.
<li>The <var>TranIn</var> method continues with the next statement if <code>ONRESET
CONTINUE</code>, <code>CANCELC</code>, or <code>LABELC</code> is in effect for the socket.
It always returns the translated string; it never returns an error indicator.
<li>Typically, <var>TranIn</var> is used to translate into EBCDIC
strings that are received from non-mainframe sources that use other
character mapping schemes, like ASCII or non-English character sets.
</ul>

==Example==

In the following example, parsed but not translated lines are received into the
<code>%s</code> variable, then translated, and printed in EBCDIC.
%sock is Object <var>Socket</var>
%sock = New
%old = %sock:Set('BINARY')
Repeat
%len = %sock:ReceiveAndParse(%s)
If %len le 0 Then
Loop End
End If
%xlate = %sock:TranIn(%s)
Print %xlate
End Repeat
%old = %sock:Set('BINARY', %old)

ServerSocket (Socket function)

2011-11-08T19:34:02Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> ServerSocket function <var>ServerSocket</var> is a member of t..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|ServerSocket function]]

<var>ServerSocket</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This [[Notation conventions for methods#Shared members|shared]] method obtains a reference to a
<var>Socket</var> object for the server socket (socket number 1 in the <var>$Sock_xxx</var> API,
as described in [[Janus Sockets User Language coding considerations#Client versus Server Socket programming|"Client versus Server Socket programming"]].
It returns a reference to a <var>Socket</var> object instance, which can then be
used with instance method calls to access the server socket.
<var>ServerSocket</var> has no equivalent $function.

==ServerSocket syntax==
 %so = %(Socket):ServerSocket

===Syntax terms===
<table class="syntaxTable">
<tr><th>%so</th>
<td>A declared socket object or a reference to a <var>Socket</var> object.
</td></tr>
<tr><th>%(Socket)</th>
<td>The class name in parentheses denotes a shared method. Specifying <code>%(Socket):</code> is not the only way to invoke the method (see [[??]] refid=themeth.).

</td></tr></table>

==Usage notes==
<ul>
<li>After <var>ServerSocket</var> returns, the socket is no longer accessible by its
socket number (1).
To access the socket by its number again, use
<var>[[GetSocketNumber (Socket function)|GetSocketNumber]]</var>.
<li><var>ServerSocket</var> can be used to obtain a <var>Socket</var> object reference for a socket already
created by <var>$Sock_Conn</var>, or it can operate in an entirely object-oriented application.
</ul>

==Example==

In the following code fragment, a server socket receives data and replies to its client.
Begin
%r Float
%sepx Float
%data is String len 255
%servsock is Object <var>Socket</var>
%servsock = %(Socket):ServerSocket
%r = %servsock:Set('PRSTOK', 'AMBIG|0D0A|0D|0A|07')
%r = %servsock:Set('LINEND', '07')
%r = %servsock:ReceiveAndParse(%data)
If %r le 0 Then
...
If %data eq 'Hello' Then
...
%r = %servsock:SendWithLineEnd('OK')
...

OnReset (Socket function)

2011-11-08T19:34:01Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> OnReset function <var>OnReset</var> is a member of the <var>[[..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|OnReset function]]

<var>OnReset</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This callable, [[Notation conventions for methods#Shared members|shared]] method
specifies the label in the <var class="product">User Language</var> sockets program to jump to
when a <var>RESET</var> socket is encountered in the current or a lower program scope.
It can also be used to clear without replacing an existing <var>ONRESET</var> label.
The <var>OnReset</var> function has an effect similar to <var>[[$Sock_Onreset]]</var>.
==Syntax==
%rc = %(Socket):OnReset[('label')]

===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>Numeric return string, which is to contain 0 (success) or a negative integer (see <var class="term">label</var>, below).
</td></tr>
<tr><th>%(Socket)</th>
<td>The class name in parentheses denotes a shared method. Specifying <code>%(Socket):</code> is not the only way to invoke the method (see [[??]] refid=themeth.).
</td></tr>
<tr><th>label</th>
<td>The label in the program to which to jump to for <var>ONRESET</var> handling. If <var class="term">label</var> is the null string or all blanks, any existing <var>ONRESET</var> label in the current scope is cleared, and <var>OnReset</var> returns: <ul> <li>-3, if <var>OnReset</var> is issued from an <var>ON</var> unit <li>-1, otherwise </ul>

</td></tr></table>
==Usage notes==
<ul>
<li>If <var class="term">label</var> is a valid label
and the <var>OnReset</var> function call is successful, any existing <var>ONRESET</var> label
definition in the current scope is replaced, and <var>OnReset</var> returns 0.
<li>If the <var>OnReset</var> call fails to clear or to set the <var>ONRESET</var> label, the request is cancelled.
<var>OnReset</var> can fail for the following reasons:
<ul>
<li><var class="term">label</var> is not found in the current scope.
<li><var class="term">label</var> is a subroutine.
<li><var>OnReset</var> is invoked from an <var>ON</var> unit, and <var class="term">label</var> is neither the
null string nor all blank.
<li><var class="term">label</var> is in a loop, <var>ON</var> unit, or simple subroutine.
</ul>
<li><var>OnReset</var> is not affected by any <var>ONRESET</var> setting.
<li>A request may have multiple <var>ONRESET</var> labels set: as many as one for each
scope (the outer level of a request is a scope, as is each complex subroutine).
As described in [[Janus Sockets User Language coding considerations#Handling connection errors and RESET sockets|"Handling connection errors and RESET sockets"]],
a jump to an <var>ONRESET</var> label is attempted if both of these are true:
<ul>
<li>A <var>RESET</var> socket is
encountered during a <var class="product">Janus Sockets</var> operation
<li>The socket's <var>ONRESET</var> setting
is <code>LABEL</code> (or <code>LABELC</code>, if the operation requires an <var>OPEN</var> socket)
</ul>
<li>An attempted jump to a label is successful if there is an <var>ONRESET</var> label
within the current or an invoking scope of the <var class="product">User Language</var> request
that encountered the <var>RESET</var> socket.
If there is no such label, the <var class="product">User Language</var> request is cancelled.
<li>Using <var>OnReset</var> to set an <var>ONRESET</var> handler reduces the
amount of return code checking the application has to do on each method call.
</ul>

==Example==

As a result of the <var>OnReset</var> code in the following example, encountering
a <var>RESET</var> socket will print a set of error messages that provide the
failing operation, return code, and socket
identifier before terminating evaluation:
Call %(Socket):OnReset('KABOOM')
...

KABOOM:
%c = %(Socket):Errinfo('CODE')
%s = %(Socket):Errinfo('SOCKNUM')
%f = %(Socket):Errinfo('FUN')
Print 'The connection was unexpectedly lost.'
Print 'The last sockets error operation was:'
Print 'Function: ' with %f
Print 'Return code: ' with %c
Print 'Socket: ' with %s
Stop

GetSocketObject (Socket function)

2011-11-08T19:33:59Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> GetSocketObject function <var>GetSocketObject</var> is a membe..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|GetSocketObject function]]

<var>GetSocketObject</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This [[Notation conventions for methods#Shared members|shared]]
method returns a <var>Socket</var> object for a given socket number.
It returns a reference to an instance of a
<var>Socket</var> object, which can then be used with instance method calls.
==Syntax==
%so = %(Socket):GetSocketObject(socketnum)

===Syntax terms===
<table class="syntaxTable">
<tr><th>%so</th>
<td>A declared socket object or a reference to a <var>Socket</var> object.
</td></tr>
<tr><th>%(Socket)</th>
<td>The class name in parentheses denotes a shared method. Specifying <code>%(Socket):</code> is not the only way to invoke the method (see [[??]] refid=themeth.).
</td></tr>
<tr><th>socketnum</th>
<td>The number of a socket that was created with <var>[[$Sock_Conn]]</var>.

</td></tr></table>

==Usage notes==
<ul>
<li><var>GetSocketObject</var> is designed for adding <var>Socket</var> object code to an existing
$Sock_xxx application, that is, for
instantiating a socket from a socket number returned from <var>$Sock_Conn</var>.
If you are building an entirely object-oriented socket application,
use the <var>[[New (Socket constructor)|New]]</var> constructor.
<li>After <var>GetSocketObject</var> returns, the socket is no longer accessible by its socket number.
To access the socket by its number again, use <var>[[GetSocketNumber (Socket function)|GetSocketNumber]]</var>.
<li>If the object returned by a <var>GetSocketObject</var> invocation is the method object
for a subsequent <var>GetSocketNumber</var> invocation, the
<code>NOCLOSE</code> setting of the original numbered socket is applied to the
numbered socket returned by <var>GetSocketNumber</var>.
For information about <var>NOCLOSE</var>, see <var>[[Set (Socket function)|Set]]</var>.
</ul>

==Example==

In the following example,a socket created with <var>$Sock_Conn</var> is
converted to a <var>Socket</var> object.
JANUS DEFINE PIPE * CLSOCK 8 REMOTE * * SOCKPMAX 10
JANUS START PIPE
Begin
%nums Is String Len 16
%sockhrb object <var>Socket</var>
%CONN is float

%CONN = $SOCK_CONN('PIPE', 'www.whrb.org', 80)
%nums = %(Socket):Num('OPEN')
%sockhrb = %(Socket):GetSocketObject(%nums)
Print 'The %sockhrb status is: ' %sockhrb:Info('STAT')
End


The example result is:
The %sockhrb status is: CONN

GetSocketNumber (Socket function)

2011-11-08T19:33:59Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> GetSocketNumber function <var>GetSocketNumber</var> is a membe..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|GetSocketNumber function]]

<var>GetSocketNumber</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This method returns a socket number for the method <var>Socket</var> object.
The returned number can then be used with $Sock_xxx calls,
so $Sock_xxx code can be used in conjunction with a <var>Socket</var> object.
==Syntax==
%snum = %socko:GetSocketNumber

===Syntax terms===
<table class="syntaxTable">
<tr><th>%snum</th>
<td>A numeric variable to contain the value of the number of the <var class="term">%socko</var> socket.
</td></tr>
<tr><th>%socko</th>
<td>A variable or an expression that is a reference to a <var>Socket</var> object.

</td></tr></table>
==Usage notes==
<ul>
<li>After <var>GetSocketNumber</var> returns, the <var>Socket</var> object is no longer valid:
it is null, and the socket is only accessible by the returned number.
To access the socket as an object again, you use
<var>[[GetSocketObject (Socket function)|GetSocketObject]]</var>.
<li>If the object returned by a <var>GetSocketObject</var> invocation is the method object
for a subsequent <var>GetSocketNumber</var> invocation, the
<code>NOCLOSE</code> setting of the original numbered socket is applied to the
numbered socket returned by <var>GetSocketNumber</var>.
For information about <var>NOCLOSE</var>, see <var>[[Set (Socket function)|Set]]</var>.
</ul>

ErrInfo (Socket function)

2011-11-08T19:33:58Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> ErrInfo function <var>ErrInfo</var> is a member of the <var>[[..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|ErrInfo function]]

<var>ErrInfo</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This [[Notation conventions for methods#Shared members|shared]] method retrieves information about the last <var
class="product">Janus Sockets</var> error.
The <var>ErrInfo</var> function is similar in effect to
<var>[[$Sock_Errinfo]]</var>.
==Syntax==
%errinfo = %(Socket):ErrInfo(infotype)

===Syntax terms===
<table class="syntaxTable">
<tr><th>%errinfo</th>
<td>A string variable to contain the returned error information. If no <var class="product">Janus Sockets</var> error has occurred since the thread logged in, a null string is returned.
</td></tr>
<tr><th>%(Socket)</th>
<td>The class name in parentheses denotes a shared method. Specifying <code>%(Socket):</code> is not the only way to invoke the method (see [[??]] refid=themeth.).
</td></tr>
<tr><th>infotype</th>
<td>One of the following strings: <table class="syntaxTable"> <tr><th><var>CODE</var> </th><td>Retrieve the code from the last <var class="product">Janus Sockets</var> error.
</td></tr>
<tr><th><var>SOCKNUM</var>
</th><td>Retrieve the socket number used by the last <var class="product">Janus Sockets</var> operation with an error condition.
</td></tr>
<tr><th><var>FUN</var>
</th><td>Retrieve the name of the $function producing the last <var class="product">Janus Sockets</var> error. This may also be the string "Captured print", if a captured "print" operation was the last operation that encountered a <var class="product"</td></tr></table>

</td></tr></table>

<var>ErrInfo</var> is not affected by any <code>ONRESET</code> setting.

Close (Socket function)

2011-11-08T19:33:58Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> Close function <var>Close</var> is a member of the <var>[[Sock..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|Close function]]

<var>Close</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This method terminates the sending and receiving of data on, and removes from use,
a <var class="product">Janus Sockets</var> connection.
The <var>Close</var> method, which may be invoked with a <var>Call</var> statement, has an effect
similar to its equivalent $function, <var>[[$Sock_Close]]</var>.
==Syntax==
[%conn =] %socko:Close

===Syntax terms===
<table class="syntaxTable">
<tr><th>%conn</th>
<td>If specified, this is a numeric variable to contain the returned value <code>1</code> from <var>Close</var>, indicating the connection is closed.
</td></tr>
<tr><th>%socko</th>
<td>A variable or an expression that is a reference to a <var>Socket</var> object.

</td></tr></table>
==Usage notes==
<ul>
<li>In addition to closing the socket, the <var>Close</var> method
destroys (discards) the object.
<li><var>Close</var> is not affected by any <code>ONRESET</code> setting.
If the socket for which it is invoked is in the <code>RESET</code> state,
<var>Close</var> continues to the next statement and does not set the last socket error information.
</ul>

==Example==

The <var>Close</var> call signals that the program has completed all processing on the
<code>%sok</code> socket:
%sok:Close

Capture (Socket function)

2011-11-08T19:33:57Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> Capture function <var>Capture</var> is a member of the <var>[[..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Socket methods|Capture function]]

<var>Capture</var> is a member of the <var>[[Socket class|Socket]]</var> class.


This method
specifies whether print output should be sent as lines on a <var class="product">Janus Sockets</var> connection.
The method, which may be invoked with a CALL statement,
has an effect similar to its equivalent $function,
<var>[[$Sock_Capture]]</var>.
==Syntax==
[%str =] %socko:Capture(value)


===Syntax terms===
<table class="syntaxTable">
<tr><th>%str</th>
<td>Optional return string, which contains the value of the socket's previous print capture setting. If the socket is not open, and <code>ONRESET CONTINUE</code> is in effect for the socket, <var>Capture</var> returns the string <code>RESET</code>. For information about <code>ONRESET CONTINUE</code>, see the <var>[[Set (Socket function)|Set]]</var> method.
</td></tr>
<tr><th>%socko</th>
<td>A variable or an expression that is a reference to a <var>Socket</var> object.
</td></tr>
<tr><th>value</th>
<td>The print capture setting for the socket. It is a string whose valid values are: <table> <tr><th>OFF </th><td>Do not capture print output to this socket.
</td></tr>
<tr><th>ON
</th><td>Capture print output to this socket.
</td></tr></table>
</td></tr></table>

==Usage notes==
<ul>
<li>Unlike <var>$Sock_Capture</var>, capturing to multiple sockets
is '''not''' supported with a <var>Socket</var> object.
<li>Each captured print line is followed by a <var>LINEND</var> string,
if the socket has one set in its definition or by the <var>Set</var> method.
<li>If <var>FIN</var> is sent (using either the <var>Send</var> or <var>SendWithLineEnd</var> method),
print capturing is automatically turned <var>OFF</var> for the socket.
</ul>

For information about "print" output, see [[$Sock_Capture#Print capturing hierarchy and other considerations|"Print
capturing hierarchy and other considerations"]].

Unbind (LDAP function)

2011-07-08T20:17:34Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> Unbind function <var>Unbind</var> is a member of the <var>[[Ldap..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Ldap methods|Unbind function]]

<var>Unbind</var> is a member of the <var>[[Ldap class|Ldap]]</var> class.


This [[Notation conventions for methods#Callable methods|callable]]
function closes a Janus LDAP connection.
It logs off the LDAP user, and it terminates the sending and receiving of
data on the connection and deactivates it.
==Syntax==
[%st =] %ld:Unbind

===Syntax terms===
<table>
<tr><th>%st
</th><td>A float variable to contain the status result of the Unbind. Possible results are: <ul> <li>0, which indicates success <li>-1, which indicates a failure due to a lost connection (or a connection was never established) </ul>

The <var>[[ErrorNumber (Ldap property)|ErrorNumber]]</var> and <var>[[ErrorText (Ldap property)|ErrorText]]</var> methods may provide additional details.
</td></tr>
<tr><th>%ld
</th><td>An <var>Ldap</var> object variable.
</td></tr></table>
==Usage Notes==
<ul>
<li>After a successful <var>Unbind</var> (and after errors that cause a disconnection),
the <var>Ldap</var> method object is ready for another <var>Bind</var>:
that is, it is (re)initialized with no associated socket/connection references,
in the same state as if <code>%ld = New</code> were issued.
<li>You can also close a connection (and delete the object) abruptly by issuing
a <var>Discard</var> call, and you can achieve the same result by letting an <var>Ldap</var> object
get discarded automatically (“implicitly”) when the last
reference to it is lost, but it is recommended that you first issue an
<var>Unbind</var> call for a more orderly closure.
</ul>

FindApprox (LDAP function)

2011-07-08T20:17:33Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> FindApprox function <var>FindApprox</var> is a member of the <va..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Ldap methods|FindApprox function]]

<var>FindApprox</var> is a member of the <var>[[Ldap class|Ldap]]</var> class.


This [[Notation conventions for methods#Callable methods|callable]] function
retrieves all records (entries) from the LDAP directory
for which the attribute type you specify has a value
that matches equally or for which some locally-defined approximate matching
algorithm (based on spelling variations or phonetic match, for example) returns
“True” for the search string you specify.
==Syntax==
[%st =] %ld:FindApprox( attrib, searchString, %doc, -
[, AttributesOnly=bool] -
[, ReturnAttributes=%sl] -
[, BaseObject=string] )


The syntax terms and most of the usage notes for this function are the
same as those for <var>[[FindEQ (Ldap function)|FindEQ]]</var>.

For additional information, see [[LDAP Helper#Using the Find methods|"Using the Find methods"]].

FindLE (LDAP function)

2011-07-08T20:17:32Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> FindLE function <var>FindLE</var> is a member of the <var>[[Ldap..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Ldap methods|FindLE function]]

<var>FindLE</var> is a member of the <var>[[Ldap class|Ldap]]</var> class.


This [[Notation conventions for methods#Callable methods|callable]] function
retrieves all records (entries) from the LDAP directory
for which the attribute type you specify has a value that matches equally or
falls alphabetically before the search string you specify.

<var>FindLE</var> with a search string
of <code>C</code> for the attribute type <code>sn</code>, for example,
would find every entry keyed with an “sn” value that begins with
an “A” or “B”.
==Syntax==
[%st =] %ld:FindLE( attrib, searchString, %doc, -
[, AttributesOnly=bool] -
[, ReturnAttributes=%sl] -
[, BaseObject=string] )


The syntax terms and most of the usage notes for this function are the
same as those for <var>[[FindEQ (Ldap function)|FindEQ]]</var>.

For additional information, see [[LDAP Helper#Using the Find methods|"Using the Find methods"]].

FindGE (LDAP function)

2011-07-08T20:17:32Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> FindGE function <var>FindGE</var> is a member of the <var>[[Ldap..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Ldap methods|FindGE function]]

<var>FindGE</var> is a member of the <var>[[Ldap class|Ldap]]</var> class.


This [[Notation conventions for methods#Callable methods|callable]]
function retrieves all records (entries) from the LDAP directory
for which the attribute type you specify has a value that matches equally or
falls alphabetically after the search string you specify.

<var>FindGE</var> with a search string
of <code>A</code> for the attribute type <code>sn</code>, for example,
would find every entry keyed with an “sn” value that begins with
“A”.
==Syntax==
[%st =] %ld:FindGE( attrib, searchString, %doc, -
[, AttributesOnly=bool] -
[, ReturnAttributes=%sl] -
[, BaseObject=string] )


The syntax terms and most of the usage notes for this function are the
same as those for <var>[[FindEQ (Ldap function)|FindEQ]]</var>.

For additional information, see [[LDAP Helper#Using the Find methods|"Using the Find methods"]].

ErrorText (LDAP function)

2011-07-08T20:17:31Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> ErrorText property <var>ErrorText</var> is a member of the <var>..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Ldap methods|ErrorText property]]

<var>ErrorText</var> is a member of the <var>[[Ldap class|Ldap]]</var> class.


This method is a read-only property that reports the error message text from the
last <var>Ldap</var> method for which an error message was returned.
==Syntax==
%msg = %ld:ErrorText

===Syntax terms===
<table>
<tr><th>%msg
</th><td>A string variable to contain the returned error message text. The ''%msg'' value is an empty string if no methods have been called.
</td></tr>
<tr><th>%ld
</th><td>An <var>Ldap</var> object variable.
</td></tr></table>
==Usage Notes==
<ul>
<li>The <var>[[ErrorNumber (Ldap property)|ErrorNumber]]</var> property reports
the error number associated with the ErrorText message or a number
of a related error.
<li>The <var>ErrorText</var> message will be the same as that indicated by the status
return from <var>Ldap</var> methods
for problems “internal” to the client, will be a message from a
related error, or will be a message from a server-reported error.
<li>If an <var>ErrorText</var> message (and number) contain information reported by the
server, they ''may'' conform to the LDAP RFC,
which lists dozens of such server result codes (positive integers)
and descriptions,
but no accompanying diagnostic text for these codes is standardized.
</ul>
==Examples==
<ul>
<li>An <var>Ldap</var> <var>Bind</var> call fails and returns a status value of <code>-5</code>,
which indicates that the bind authorization failed.
When the following statement was issued:
 Print 'Error text is ': ' %ld:ErrorText


The result was: <code>Error text is LDBIND FTPCONN failed to connect</code>.
<var>ErrorText</var> and returned status provide corroborating information.
</ul>

ErrorNumber (LDAP function)

2011-07-08T20:17:31Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> ErrorNumber property <var>ErrorNumber</var> is a member of the <..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:Ldap methods|ErrorNumber property]]

<var>ErrorNumber</var> is a member of the <var>[[Ldap class|Ldap]]</var> class.


This method is a read-only property that reports the error number
from the last <var>Ldap</var> method for which an error number was returned.
==Syntax==
%num = %ld:ErrorNumber

===Syntax terms===
<table>
<tr><th>%num
</th><td>A float variable to contain the integer-valued error number.
</td></tr>
<tr><th>%ld
</th><td>An <var>Ldap</var> object variable.
</td></tr></table>
==Usage Notes==
<ul>
<li>The <var>[[ErrorText (Ldap property)|ErrorText]]</var> property reports a
short description of the error associated with the <var>ErrorNumber</var> value
or additional information related to the error.
<li>The <var>ErrorNumber</var> value will be the same as the status return from <var>Ldap</var> methods
for problems "internal" to the client, will contain a value from a
related error, or will contain a value from a server-reported error.
<li>If an <var>ErrorNumber</var> (and text) contain information reported by the server,
they ''may'' conform to the LDAP RFC,
which lists dozens of such server result codes (positive integers)
and descriptions,
but no accompanying diagnostic text for these codes is standardized.
</ul>
==Examples==
<ul>
<li>An <var>Ldap</var> <var>Bind</var> call fails and returns a status value of <code>-110</code>,
which indicates a problem with the Janus port definition.
When the following statement was issued:
 Print 'Error number is ': ' %ld:ErrorNumber


The result was: <code>Error number is -110</code>.
<var>ErrorNumber</var> and status return both point to the client fault.
<li>An <var>Ldap</var> <var>Find</var> call fails and returns a status value of <code>-5</code>,
which indicates an "error obtained from server."
When the following statement was issued:
 Print 'Error number is ': ' %ld:ErrorNumber


The result was: <code>Error number is 4</code>,
and the <var>ErrorText</var> string indicated that "the size limit of returned
entries has been exceeded."
<var>ErrorNumber</var> and status return, though different, both point to a server issue.
</ul>

URL (HttpResponse function)

2011-06-17T19:21:24Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> Url property <var>Url</var> is a member of the <var>[[Ht..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:HttpResponse methods|Url property]]

<var>Url</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.


This non-settable method returns the actual URL from
which a response was obtained.
In the case of server redirects, the URL returned by this method
will '''not''' be the URL requested on the <var>HTTPRequest</var> object.
==Syntax==
%string = %httpresp:Url


===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th>
<td>A string variable for the assignment of the Url property value of ''%httpresp''.
</td></tr>
<tr><th>%httpresp</th>
<td>A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.

</td></tr></table>

==Usage Notes==

The URL method can inform an
application that a redirection happened and what the
real location of the requested item was.
For example:
 %HTTPResponse = %HTTPRequest:Get('XMLCLIENT')

if (%HTTPResponse:URL ne %HTTPRequest:URL) then
print 'Hey Moe, we got redirected to ' and -
%HTTPResponse:URL
end if

Success (HttpResponse function)

2011-06-17T19:21:23Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> Success property <var>Success</var> is a member of the <..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:HttpResponse methods|Success property]]

<var>Success</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.


This non-settable method lets you check the status
code value in the status line of the
result of the most recent <var>[[Get (HttpResponse function)|Get]]</var>, <var>[[Post (HttpResponse function)|Post]]</var>, or <var>[[Send (HttpResponse function)|Send]]</var> operation.
==Syntax==
%boolean = %httpresp:Success


===Syntax terms===
<table class="syntaxTable">
<tr><th>%boolean</th>
<td>A numeric variable for the assignment of the Success value of ''%httpresp''. Success returns 1 (True) if the HTTP status code is in the 200s (success range), and it returns 0 (False) otherwise.
</td></tr>
<tr><th>%httpresp</th>
<td>A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.

</td></tr></table>
==Usage Notes==

If <var>Success</var> returns 1 (True),
content was retrieved and is available via the <var>[[Content (HttpResponse function)|Content]]</var>
and <var>[[ParseXML (HttpResponse function)|ParseXML]]</var> methods.

StatusLine (HttpResponse function)

2011-06-17T19:21:23Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> StatusLine property <var>StatusLine</var> is a member of..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:HttpResponse methods|StatusLine property]]

<var>StatusLine</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.


This non-settable method lets you check the HTTP status line of the
result of the most recent <var>[[Get (HttpResponse function)|Get]]</var>, <var>[[Post (HttpResponse function)|Post]]</var>, or <var>[[Send (HttpResponse function)|Send]]</var> operation.
<var>StatusLine</var> returns the whole HTTP status line, which consists of
a code, a blank, and a message (for example, "200 OK").
==Syntax==
%statusline = %httpresp:StatusLine


===Syntax terms===
<table class="syntaxTable">
<tr><th>%statusline</th>
<td>A string or longstring variable for the assignment of the StatusLine value of ''%httpresp''.
</td></tr>
<tr><th>%httpresp</th>
<td>A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.

</td></tr></table>

Print (HttpResponse subroutine)

2011-06-17T19:21:23Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> Print subroutine <var>Print</var> is a member of the <va..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:HttpResponse methods|Print subroutine]]

<var>Print</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.


The <var>Print</var> subroutine displays a report of the
<var>HTTPResponse</var> instance that is useful for debugging. The
display is sent to wherever <var class="product">User Language</var> <var>Print</var> statement output is currently
being directed.
==Syntax==
%httpresp:Print


===Syntax terms===
<table class="syntaxTable">
<tr><th>%httpresp</th>
<td>A reference to an <var>HTTPResponse</var> object that was returned by a Get, Post, or Send method of an HTTPRequest object.

</td></tr></table>

ParseXml (HttpResponse function)

2011-06-17T19:21:22Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> ParseXML function <var>ParseXML</var> is a member of the..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:HttpResponse methods|ParseXML function]]

<var>ParseXML</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.


This method helps you access the document/content from Get, Post, and Send
operations.
ParseXML deserializes returned XML data into the [[Janus SOAP]] XmlDoc
object you specify.
Working with [[Janus SOAP]] XmlDoc objects is described in detail in the [[Janus SOAP Reference Manual]].
==Syntax==
%rc = %httpresp:ParseXML(%xmldoc, [xmloptions])


===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>A numeric variable. Successful deserialization returns 0; failure returns a non-zero value.
</td></tr>
<tr><th>%httpresp</th>
<td>A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.
</td></tr>
<tr><th>%xmldoc</th>
<td>An object of type [[Janus SOAP]] XmlDoc that contains an instantiated XmlDoc object, which must be EMPTY.
</td></tr>
<tr><th>xmloptions</th>
<td>Any valid combination of the following (which are the same as the options of the LoadXML method of the [[Janus SOAP]] XmlDoc object): <ul> <li>AllowUntranslatable
Allows all valid Unicode strings into the XML document. When this option is not specified, Unicode strings that are not translatable to EBCDIC are not allowed.
As described in [[##Deserializing Unicode strings|"Deserializing Unicode strings"]], it is recommended that you use <var>AllowUntranslatable</var> only if the application checks for translatability when accessing parts of the <var>XmlDoc</var> that may have untranslatable Unicode content.
The <var>AllowUntranslatable</var> option is available as of version 7.6 of the <var class="product">Sirius Mods</var>. <li>CrPreserve
All whitespace characters in Element content are preserved, including carriage return. Unlike all other deserialization options, a carriage return in Element content does ''not'' undergo the normalization specified in the XML standard (and described in [[XML processing in Janus SOAP#Normalizing whitespace characters|"Normalizing whitespace characters"]]).
<var>CrPreserve</var> is mutually exclusive with the <var>WspNewline</var>, <var>WspToken</var>, and <var>WspPreserve</var> options, and with the <var>LinefeedNoTrailingTabs</var> option.
The <var>CrPreserve</var> option was added in version 7.5 of the <var class="product">Sirius Mods</var>, as well as implemented with a maintenance zap to the 7.4 <var class="product">Sirius Mods</var>. <li>DTDIgnore
A “<!DOCTYPE&thinsp....>” clause may be present in the document, and it should be ignored. In any case, the DTD is not processed. The default behavior, that is, if <var>DTDIgnore</var> is not present, is to treat “<!DOCTYPE&thinsp....>” as a syntax error.
<var>DTD_Ignore</var> is a synonym for <var>DTDIgnore</var>. <li>ErrRet
Errors during deserialization are tolerated, the method object is not updated (retains its pre-call state), and the request continues. If <var>ErrRet</var> is not present, any error will cancel the request. Note that some errors still cancel the request; errors tolerated when <var>ErrRet</var> is specified are: <ul> <li>A syntax error in the text string representation of the XML document </ul> <li>LinefeedNoTrailingTabs
For a Text node that consists of an initial line-end character and one or more tab characters, this option normalizes the content so the result is a single line-end character. The initial line-end (also called "newline") character can be a linefeed character (LF) or a carriage-return (CR) by itself, or a carriage-return followed by a linefeed (CRLF), since (within Text nodes) all of these are normalized by the XML specification into a single line-end character.
This option, added in <var class="product">Sirius Mods</var> version 7.0, is compatible with, but takes precedence over, any of the other whitespace-handling options (<var>WspNewline</var>, <var>WspToken</var>, <var>WspPreserve</var>) except <var>CrPreserve</var>.
See [[#Whitespace handling|"Whitespace handling"]], below, for more information about this option and about whitespace handling. <li>ReplaceUnicode
Converts Unicode characters using the replacements (if any) specified at your site by <var>[[Unicode|The UNICODE command|UNICODE]]</var> updating commands that use the <var>Rep</var> subcommand (for example, <code>UNICODE Table Standard Rep U=2122 '(TM)'</code>).
The replacement is performed on all names, element and attribute values, comments, and PI “values” in the document, after any entity and character references have been converted to characters.
For further discussion and examples, see the <var>ReplaceUnicode</var> discussion in [[#Usage Notes|"Usage Notes"]], below.
<li>WspNewline
This option is designed to remove any whitespace inserted to make the structure of an XML document easier (for a person) to read. <var>WspNewline</var> removes the leading or trailing whitespace in the value of a Text node, if the whitespace sequence contains a newline (carriage return or linefeed) character. '''Note:''' This handling, the default whitespace option for this method, applies to the "physical value" of the representation of a Text node. In particular, markup such as a character reference (even of whitespace, for example, <code>&#32;</code>), a CDATA section, or any non-whitespace character delimits leading or trailing whitespace and is not affected.
See [[Whitespace handling|"Whitespace handling"]], below, for more information about whitespace handling.
<li>WspPreserve
All whitespace characters in element content are preserved (after end-of-line normalization), as described below in [[Whitespace handling|"Whitespace handling"]]. '''Note:''' <var>Wsp_Preserve</var> is a synonym for <var>WspPreserve</var>. <li>WspToken
Whitespace in element content is normalized using the XPath <code>normalize()</code> function (leading and trailing whitespace removed, intermediate strings of whitespace replaced by a single blank character). <var>WspToken</var> is a good substitute for <var>WspNewline</var> to remove leading and trailing whitespace in cases where blanks (or tabs) and not line-end characters were used to make the document structure more readable — if it is tolerable to collapse intermediate whitespace sequences to single space characters.
See [[Whitespace handling|"Whitespace handling"]] for more information about whitespace handling. </ul>

</td></tr></table>
==Usage Notes==
<ul>
<li><var>ParseXML</var> is equivalent to, but faster than, issuing the <var class="product">Janus SOAP</var> XML
text-conversion
method <var>[[LoadXml (XmlDoc/XMLNODE FUNCTION)|LOADXml]]</var> against the longstring returned
by <var>[[Content (HttpResponse function)|Content]]</var>.bot
<li>If the content type header indicates HTML, XML, or plain text,
ASCII-to-EBCDIC translation is performed.
If the <var>Clsock</var> port definition specifies a translation table for ASCII-to-EBCDIC,
that table is used instead of the default.
<li>None of the ''options'' may be specified twice.
<li>The ''options'' may be specified in any case.
For example, you can use
<code>WspPreserve</code> and <code>wsppreserve</code>, interchangeably.
<li>Whitespace handling
<ul>
<li>The “Wsp” whitespace-handling ''options''
(<var>WspPreserve</var>, <var>WspNewline</var>, and <var>WspToken</var>) and the <var>CrPreserve</var> whitespace option
are mutually exclusive; if none of them is specified, <var>WspNewline</var> is in effect.
Although the <var>LinefeedNoTrailingTabs</var> option is also concerned with whitespace,
it is distinct from, yet compatible with, any of the three “Wsp” options,
but it is not compatible with the <var>CrPreserve</var> option.
<li>Except for <var>CrPreserve</var>, the whitespace-handling ''options'' are
applied after the XML standard whitespace conversions that <var class="product">[[Janus SOAP]]</var> always applies.
As described in [[XML processing in Janus SOAP#Normalizing whitespace characters|"Normalizing whitespace characters"]],
the standard specifies that '''all''' carriage return/linefeed
sequences and carriage return sequences are to be converted to linefeeds
when deserializing.
Using the CrPreserve option bypasses this rule.
<li>The whitespace-handling ''options'' do '''no''' whitespace
conversion (beyond the XML standard conversions) on element content that is
“protected” by the <code>xml:space="preserve"</code> attribute.

“Protected” by the xml:space="preserve" attribute
means an element E that either:
<ul>
<li>has the <code>xml:space</code> attribute with the value <code>preserve</code>
<li>is contained in
an element A with that attribute and value, and there is no
element that is a descendent of A and an ancestor of E
with the <code>xml:space</code> attribute with the value <code>default</code>
</ul>

Elements that are
not protected by the <code>xml:space="preserve"</code> attribute
have whitespace handled
according to the option in effect for the deserialization.
<li>Using <var>WspNewline</var> or <var>WspToken</var>
reduces the space consumed by individual Text nodes,
and in some cases
collapses all whitespace content between markup to the null
string, so it is not stored as a <var>Text</var> node.
This reduces the storage required by the <var>XmlDoc</var>, speeds up
XPath and node access processing, and makes the output of the
<var>[[Print (HttpResponse subroutine)|Print]]</var> subroutine easier to read.
<li>The <var>LinefeedNoTrailingTabs</var> option only affects Text nodes that contain
an initial line-end character followed by any number of tabs and nothing else.
The <var>LinefeedNoTrailingTabs</var> effect on such a Text node,
whether it is specified with or without any of the “Wsp” options,
is to store the value of the node as a single line-end character.

One example of the use of the <var>LinefeedNoTrailingTabs</var> option is
an input XML document to be deserialized for which
both of the following are true:
<ul>
<li>A digital signature is needed of a subtree in the document.
<li>The input subtree contains a linefeed and one or more tabs that
separate markup, and the linefeed must be kept but the tabs discarded
for the signature.
</ul>

For information about exclusive canonicalization,
serialization expressly designed for digital signatures,
see [[XmlDoc API serialization options#Canonicalization|"Canonicalization"]].

<li>Deserializing Unicode strings
<ul>
<li>The <var>ParseXml</var> <var>AllowUntranslatable</var> option
lets you deserialize Unicode strings that contain characters
that are not translatable to EBCDIC.
Otherwise, such characters in an input XML document are detected,
an <var>XmlParseError</var> exception
with reason <code>UntranslatableUnicode</code> is thrown, and
the request is canceled.

This default detection of non-translatable characters may suit your purposes.
That is, it ensures that subsequent
access to the deserialized content is performed
without any Unicode to EBCDIC translation errors.
For example:
 %doc:ParseXml
...
%val Longstring
%val = %doc:Value(%xpath)


The assignment to the EBCDIC string <code>%val</code> will not fail due
to a Unicode translation problem: if there is any untranslatable
Unicode (including, of course, strings in the XML document which your
application never accesses), the <var>ParseXml</var> operation fails.

If you use <var>AllowUntranslatable</var>,
all Unicode characters in a serialized input XML document are
allowed and stored in the <var>XmlDoc</var>.
Your stored data may contain content that is not translatable to
EBCDIC, however.
A subsequent attempt to access such content that
performs Unicode to EBCDIC translation might cause
request cancellation.
You should therefore use <var>AllowUntranslatable</var>
only if there is also a check for translatability
when parts of the <var>XmlDoc</var> that may
have non-translatable Unicode content are accessed.

The code below shows a way to get the benefit of specifying <var>AllowUntranslatable</var>
while limiting the risk of request cancellation.
In the example, it is believed that only the element <code>comments</code> might
contain untranslatable Unicode among all the data accessed from the XML document:
 %resp:ParseXml(%doc, 'AllowUntranslatable')
...
%uVal Unicode
%val Longstring
%uVal = %node:Value('comments')
Try %val = %uVal:UnicodeToEbcdic
Catch CharacterTranslationException
%val = %uVal:UnicodeToEbcdic(CharacterEncode=True)
Print 'Untranslatable Unicode, character encoded:' -
And %val
End Try

</ul>
'''Note:'''
Unicode values, untranslatable or not, are always allowed
when they are added to an <var>XmlDoc</var> using one of the <var class="product">Janus SOAP</var> XML
Add or Insert methods which “directly store” into an <var>XmlDoc</var>.
For example, the following fragment adds an <var>Element</var> node with
a value that is the Unicode trademark sign:
 %node:AddElement('notation', '&#x2122;':U)

<li>The <var>ReplaceUnicode</var> option lets you replace certain
Unicode input characters
with those characters you have explicitly specified (by <var>[[Unicode#The UNICODE command|UNICODE]]</var> commands
in your site's <var class="product">Model 204</var> CCAIN stream).

For example, assume the following command is in CCAIN:
 UNICODE Table Standard Rep U=2122 '(tm)'

Given the above command, the <var>ReplaceUnicode</var> option for <var><var>[[LoadXml (XmlDoc/XmlNode function)|LoadXml]]</var></var> is shown in the following fragment:
 %u Unicode Initial('<a>')
%u = %u:[[UnicodeWith (Unicode function)|UnicodeWith]]('2122':X:[[Utf16ToUnicode (String function)|Utf16ToUnicode]])
%u = %u:UnicodeWith('</a>':U)
%d:LoadXml(%u, 'ReplaceUnicode')
%d:Print

The result is:
 <a>(tm)</a>


In the preceeding example, the stream of input characters to <var>LoadXml</var>
contains the Unicode character U+2122.
Since the <var>ReplaceUnicode</var> option applies to both the stream of input characters
and to the character value of character references, consider the following fragment
(assuming the same CCAIN line as above):
 %d:LoadXml('<a>&#x2122;</a>', 'ReplaceUnicode')

The result is also:

 <a>(tm)</a>


In this case, U+2122 does not occur in the input character stream, but it is
the value of the character reference.

Notes:

<ul>
<li>It is an error to be processing a replacement string within a character
reference.
For example, assume the following two lines are in CCAIN:
 * Replace superscript 2 with digit '2':
UNICODE Table Standard Rep U=00B2 '2'

Given the above command, the following fragment gets a parse error,
because the replacement string is being used as part of a
character reference:
 %d:LoadXml('<a>&#x' With '&#xB2;':U With ';</a>', -
'ReplaceUnicode')

As a consequence of this rule, a replacement string should not
contain an ampersand character (assuming that the <var>ReplaceUnicode</var> option will
be used).
<li>Replacement of a Unicode character due to the
<var>ReplaceUnicode</var> option is only done while processing names and
values in the XML document.
It is an error if the end of the
name or value occurs and the replacement string has not been exhausted.
In other words (again assuming that the <var>ReplaceUnicode</var> option will be
used), a replacement string should not have “XML markup” that might
end a string, such as a quotation mark or a left angle bracket (<tt><</tt>).
For example, assume the following line is in CCAIN:
 UNICODE Table Standard Rep U=2122 '(trademark)<tm>'

Given the above command, the following fragment gets a parsing error,
because the '<' that is encountered in the replacement string
ends the element content:
 %d:LoadXml('<a>&#x2122;</a>':U, 'ReplaceUnicode')

<li>If a parsing error occurs after processing a Unicode character that
has been replaced, the error display of the input stream will contain the
replacement string, and the replaced character will not be displayed.
However, if the character being replaced was introduced as a character
reference, the character reference remains in the display of the input
stream.
</ul>
</ul>
</ul>
==Example==

In the following example, <var>ParseXml</var> deserializes into <code>%doc</code>
the XML data (stored in <code>%httpresp</code>) returned from a Post call:
 %httpreq is Object HttpRequest
%httpreq = new
...
%httpresp = %httpreq:Post('HTTPCLI')
%doc is Object XmlDoc
%doc = New
%httpresp:ParseXml(%doc, 'ErrRet')
%doc:Print
...

Message (HttpResponse function)

2011-06-17T19:21:22Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> Message property <var>Message</var> is a member of the <..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:HttpResponse methods|Message property]]

<var>Message</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.


This non-settable method lets you check the HTTP
status line (return code and message) of the
result of the most recent HTTP request.
The Message method returns only the message portion of the status line
(for example, <code>Forbidden</code> is returned from
a <code>403</code> <code>Forbidden</code> status line).
==Syntax==
%message = %httresp:Message


===Syntax terms===
<table class="syntaxTable">
<tr><th>%message</th>
<td>A string or longstring variable for the assignment of the Message value of ''%httpresp''.
</td></tr>
<tr><th>%httpresp</th>
<td>A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.

</td></tr></table>
==Examples==

In the following fragment, an XML document is being retrieved.
In the event of an error, the text of the status message is printed:
 . . .
%httpresp = %httpreq:Get('HHELPCLI', 0)
If (%httpresp:Success) then
%rc = %httpresp:ParseXML(%mydoc)
%mydoc:Print
Else
Print %httpresp:message
End If
. . .

HeaderValue (HttpResponse function)

2011-06-17T19:21:22Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> HeaderValue function <var>HeaderValue</var> is a member ..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:HttpResponse methods|HeaderValue function]]

<var>HeaderValue</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.


This method helps you retrieve the HTTP
response headers returned by an HTTP request.
HeaderValue returns the value of the header whose name you specify,
and it can optionally return the value of a particular occurrence
of a header.
==Syntax==
%st = %httpresp:HeaderValue(name, [sub])


===Syntax terms===
<table class="syntaxTable">
<tr><th>%st</th>
<td>A string or longstring variable for the assignment of the header value (or a zero-length string, if the requested header is not present).
</td></tr>
<tr><th>%httpresp</th>
<td>A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.
</td></tr>
<tr><th>name</th>
<td>A string expression that yields the name of an HTTP response header. If ''name'' is not present, HeaderValue returns a zero-length string.
</td></tr>
<tr><th>sub</th>
<td>Identifies a particular occurrence of header ''name''. It is a numeric expression that must evaluate to an integer from 1 through the number of occurrences of the header. The number of occurrences is available from HeaderCount(name), as described in <var>[[HeaderCount (HttpResponse function)|HeaderCount]]</var>.
If you specify a non-positive or non-numeric value, the request is cancelled. If ''sub'' is not explicitly specified, its default is 1.

</td></tr></table>

HeaderNames (HttpResponse function)

2011-06-17T19:21:21Z

198.242.244.47: Created page with " <section begin=dpl_desc/><section end=dpl_desc/> HeaderNames property <var>HeaderNames</var> is a member ..."

<section begin=dpl_desc/><section end=dpl_desc/>
[[Category:HttpResponse methods|HeaderNames property]]

<var>HeaderNames</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.


This method helps you retrieve the HTTP
response headers returned by an HTTP request.
HeaderNames returns a Stringlist object that lists the names of the HTTP response
headers returned.
==Syntax==
%sl = %httpresp:HeaderNames


===Syntax terms===
<table class="syntaxTable">
<tr><th>%sl</th>
<td>A stringlist object variable for the assignment of the returned headers of ''%httpresp''.
</td></tr>
<tr><th>%httpresp</th>
<td>A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.

</td></tr></table>