ClientCertificate (System function): Difference between revisions
m (Created page with "{{Template:System:String subtitle}} The <var>ClientCertificate</var> function returns to a Janus server a longstring that contains the binary content of a client SSL certificate....") |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:System: | {{Template:System:ClientCertificate subtitle}} | ||
The <var>ClientCertificate</var> function returns to a Janus server a longstring that contains the binary content of a client SSL certificate. | The <var>ClientCertificate</var> function returns to a Janus server a longstring that contains the binary content of a client SSL certificate. | ||
| Line 18: | Line 18: | ||
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors|shared]] method. <var>String</var> can also be invoked via a <var>System</var> object variable, which may be <var>null</var>.</td></tr> | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors|shared]] method. <var>String</var> can also be invoked via a <var>System</var> object variable, which may be <var>null</var>.</td></tr> | ||
<tr><th><var>RequestCertificate</var></th> | <tr><th><var>RequestCertificate</var></th> | ||
<td>This [[Notation conventions for methods#Named parameters|name required]] argument is a <var>[[Boolean | <td>This [[Notation conventions for methods#Named parameters|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations|Boolean]]</var> enumeration. The argument defaults to <var>False</var>, which results . | ||
< | |||
==Usage notes== | ==Usage notes== | ||
Revision as of 20:25, 4 November 2011
Get client certificate (System class)
[Introduced in Sirius Mods 8.0]
The ClientCertificate function returns to a Janus server a longstring that contains the binary content of a client SSL certificate.
RequestCertificate=True indicates that if the port definition does not have SSLCLCERT or SLCLCERTR (client certificate requested at connection time), a certificate is requested from the client at the time of the method call.
If no client certificate is present (possibly because the port is not using SSL), the ClientCertificate method returns a null string.
Syntax
%string = %(System):ClientCertificate[( [RequestCertificate= boolean])] Throws NotJanusConnection
Syntax terms
| %string | This Longstring contains the binary content of the SSL certificate presented by this server's client. | |||
|---|---|---|---|---|
| %(System) | The class name in parentheses denotes a shared method. String can also be invoked via a System object variable, which may be null. | |||
| RequestCertificate | This name required argument is a Boolean enumeration. The argument defaults to False, which results .
Usage notes
NotJanusConnection is a new exception class that has no members other than the New constructor. See also | |||