<?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="CWBSO_CreateObjHandle" />
<meta name="DC.Relation" scheme="URI" content="rzaiksoaapilist.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="cwbso_createobjhandle" />
<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>CWBSO_CreateObjHandle</title>
</head>
<body id="cwbso_createobjhandle"><a name="cwbso_createobjhandle"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">CWBSO_CreateObjHandle</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Creates a new object handle and returns
a handle to the object. Use this API to access remote object that do not conform
to the list format.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY CWBSO_CreateObjHandle(
char far* lpszSystemName,
char far* lpszApplicationName,
CWBSO_OBJTYPE type,
CWBSO_OBJ_HANDLE far* lpObjHandle); </pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">char far* lpszSystemName - input</dt>
<dd>The name of the iSeries™ system on which the object will be built.
The name that is specified must be a configured iSeries server. If the client is not
currently connected to the iSeries, a connection will be established when the
list is opened. If NULL is specified for the system name, the current iSeries default
system will be used.</dd>
<dt class="dlterm">char far* lpszApplicationName - input</dt>
<dd>A character string that identifies the application that will be interacting
with the list. The maximum length of this string is 10 characters, excluding
the NULL terminator.</dd>
<dt class="dlterm">CWBSO_OBJTYPE type - input</dt>
<dd>The type of object to be built. Specify the following: <ul><li>CWBSO_OBJ_TCIPATTR - TCP/IP attributes</li>
</ul>
</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">CWBSO_NO_ERROR</dt>
<dd>No error occurred.</dd>
<dt class="dlterm">CWBSO_LOW_MEMORY</dt>
<dd>Not enough memory is available for the request.</dd>
<dt class="dlterm">CWBSO_BAD_SYSTEM_NAME</dt>
<dd>The system name that is specified is not a valid iSeries system name.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>When the list is no longer needed, the calling
program is responsible for doing the following: </p>
<ul><li>Call <span class="apiname">CWBSO_DeleteObjHandle</span> to free up resources that
are allocated on the client.</li>
</ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksoaapilist.htm" title="The following System Object Access APIs for iSeries Access for Windows are listed alphabetically.">System Object Access APIs for iSeries Access for Windows List</a></div>
</div>
</div>
</body>
</html>