ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaikcwbcoissecuresockets.htm

83 lines
4.4 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<?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="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="reference" />
<meta name="DC.Title" content="cwbCO_IsSecureSockets" />
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist4.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="cwbco_issecuresockets" />
<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>cwbCO_IsSecureSockets</title>
</head>
<body id="cwbco_issecuresockets"><a name="cwbco_issecuresockets"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_IsSecureSockets</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This function gets (for the specified system
object) whether Secure Sockets is being used (if connected), or would be attempted
(if not currently connected) for a connection.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_IsSecureSockets(
cwbCO_SysHandle system,
cwb_Boolean *inUse );</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
<dd>Handle that previously was returned from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
It identifies the iSeries™ system.</dd>
<dt class="dlterm">cwb_Boolean * inUse - output</dt>
<dd>Returns whether iSeries Access is using, or will try to use, secure
sockets for communication: <dl><dt class="dlterm">CWB_TRUE</dt>
<dd>IS in use or would be if connections active.</dd>
<dt class="dlterm"> CWB_FALSE</dt>
<dd>NOT in use, would not try to use it.</dd>
</dl>
</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Return Codes</h4><p>The following list shows common return
values:</p>
<dl><dt class="dlterm">CWB_OK</dt>
<dd>Successful completion.</dd>
<dt class="dlterm">CWB_INVALID_API_HANDLE</dt>
<dd>Invalid system handle.</dd>
<dt class="dlterm">CWB_INVALID_POINTER</dt>
<dd>The inUse pointer is NULL.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This flag is an indication of what iSeries Access
for Windows<sup>®</sup> attempts
will TRY to do for any future communications. If CWB_TRUE is returned, then
any attempt to communicate to the iSeries system that cannot be performed
using secure sockets will fail.</p>
<p><img src="./delta.gif" alt="Start of change" />Although with limitations, iSeries Access
for Windows enforces
Federal Information Processing Standards (FIPS) compliance when SSL is used,
this API does not return an indication of whether FIPS compliance is on or
off. The only way to verify that FIPS-compliance is on or off is to visually
inspect the FIPS compliance checkbox in iSeries Access for Windows Properties.
For more information about FIPS and its use, see the User's Guide installed
with iSeries Access
for Windows. <img src="./deltaend.gif" alt="End of change" /></p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist4.htm" title="Use the APIs to get and set other system object attributes, or determine if the attributes are restricted by policies.">Communications and security: Get and set attribute APIs</a></div>
</div>
</div>
</body>
</html>