ClientCertificate (System function)

From m204wiki
Revision as of 19:33, 4 November 2011 by JAL2 (talk | contribs) (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....")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Get a system-wide string (System class)

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. If its value is:
  • False
  • True

Usage notes

  • This method can be used only on a Janus Web Server, Janus Telnet Server, or Janus Sockets Server thread. If used on any other kind of thread, it throws a NotJanusConnection exception.

NotJanusConnection is a new exception class that has no members other than the New constructor.

See also