87 lines
4.6 KiB
HTML
87 lines
4.6 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2005" />
|
||
|
|
<meta name="DC.rights.owner" content="(C) Copyright IBM Corporation 2005" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="concept" />
|
||
|
|
<meta name="DC.Title" content="cwbUN_GetSystemHandle" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzakxapis.htm" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzakxcwbungetsystemhandle" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>cwbUN_GetSystemHandle</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzakxcwbungetsystemhandle"><a name="rzakxcwbungetsystemhandle"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">cwbUN_GetSystemHandle</h1>
|
||
|
|
<div><p><strong>Purpose</strong></p>
|
||
|
|
<p>Returns a system handle that contains the security (SSL), userID, and password
|
||
|
|
settings that are used for this iSeries™ system. The system handle will
|
||
|
|
have the settings that were configured in iSeries Navigator for the input iSeries system
|
||
|
|
name.</p>
|
||
|
|
<p>If the application name is set to NULL, the returned system handle will
|
||
|
|
be unique. If the application name is set, the same system handle that matches
|
||
|
|
the application name will be returned.</p>
|
||
|
|
<p>If an application requires a unique OS/400<sup>®</sup> job for a system, then NULL or
|
||
|
|
a unique name should be passed in for the application name.</p>
|
||
|
|
<p>If an application requires to share an OS/400 job, then all callers of this
|
||
|
|
function should pass in the same application name.</p>
|
||
|
|
<p><strong>Syntax</strong> </p>
|
||
|
|
<pre>CWBAPI unsigned int WINAPI cwbUN_GetSystemHandle(
|
||
|
|
char * szSystemName,
|
||
|
|
char * szAppName,
|
||
|
|
cwbCO_SysHandle * systemHandle
|
||
|
|
);</pre>
|
||
|
|
<p><strong>Parameters</strong></p>
|
||
|
|
<dl><dt class="dlterm">char * szSystemName - input</dt>
|
||
|
|
<dd>Pointer to an ASCIIZ string that contains the name of the system for which
|
||
|
|
you want a system handle to be created.</dd>
|
||
|
|
<dt class="dlterm">char * szAppName - input</dt>
|
||
|
|
<dd>Pointer to an ASCIIZ string of no more than 12 characters. This uniquely
|
||
|
|
identifies the application that will share a single system handle.</dd>
|
||
|
|
<dt class="dlterm">cwbCO_SysHandle * systemHandle - output</dt>
|
||
|
|
<dd>Pointer to the handle of the system for this system name.</dd>
|
||
|
|
</dl>
|
||
|
|
<p><strong>Return Codes</strong></p>
|
||
|
|
<p>The following list shows common return values:</p>
|
||
|
|
<dl><dt class="dlterm">CWB_OK</dt>
|
||
|
|
<dd>Successful completion.</dd>
|
||
|
|
<dt class="dlterm">CWBUN_NULL_PARM</dt>
|
||
|
|
<dd>System name was NULL.</dd>
|
||
|
|
<dt class="dlterm">CWBUN_INVALID_NAME_PARM</dt>
|
||
|
|
<dd>The system name is not valid.</dd>
|
||
|
|
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
|
||
|
|
<dd>One or more input UNICODE characters have no representation in the code
|
||
|
|
page that is being used.</dd>
|
||
|
|
<dt class="dlterm">CWB_API_ERROR</dt>
|
||
|
|
<dd>The system handle could not be returned.</dd>
|
||
|
|
</dl>
|
||
|
|
<p><strong>Usage</strong></p>
|
||
|
|
<p>This function must be used by all third-party applications that want to
|
||
|
|
support SSL using the iSeries Access for Windows<sup>®</sup> APIs. For example, all iSeries Access
|
||
|
|
for Windows communications
|
||
|
|
APIs require a system handle to support SSL.</p>
|
||
|
|
<p>When the caller of this function no longer needs the system handle for
|
||
|
|
communications, the handle can be released by calling function <span class="uicontrol">cwbUN_ReleaseSystemHandle</span>.</p>
|
||
|
|
<p>All handles will be released when the iSeries Navigator application (cwbunnav.exe)
|
||
|
|
terminates.</p>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakxapis.htm" title="iSeries Navigator APIs help plug-in developers obtain and manage certain types of global information.">iSeries Navigator APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|