<?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_CopyObjHandle" />
<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_copyobjhandle" />
<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_CopyObjHandle</title>
</head>
<body id="cwbso_copyobjhandle"><a name="cwbso_copyobjhandle"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">CWBSO_CopyObjHandle</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Creates a new instance of an object and
returns a handle to the new instance. This does not create a new object on
the iSeries™ server.
It merely creates an additional instance of an iSeries object on the client. Object
handles that are returned by <span class="apiname">CWBSO_GetObjHandle</span> are always
destroyed when the list that contains the object is closed. This API allows
the creation of an instance of the object that will persist after the list
is closed. The object instance that was created by this API is kept in sync
with the object in the list. In other words, if one of the objects is changed,
the changes will be apparent in the other object.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY CWBSO_CopyObjHandle(
CWBSO_OBJ_HANDLE objectHandle,
CWBSO_OBJ_HANDLE far* lpNewObjectHandle); </pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">CWBSO_OBJ_HANDLE objectHandle - input</dt>
<dd>A handle to an object that was returned by a previous call to <span class="apiname">CWBSO_GetObjHandle</span> or <span class="apiname">CWBSO_CopyObjHandle</span>.</dd>
<dt class="dlterm">CWBSO_OBJ_HANDLE far* lpNewObjectHandle - output</dt>
<dd>A long pointer to a handle which will be set to a new handle for the same iSeries object.
This handle may be used with any other API that accepts an object handle
with the exception that some APIs only operate on specific types of objects.</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_OBJ_HANDLE</dt>
<dd>The object handle that is specified is not valid.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p><span class="apiname">CWBSO_GetObjHandle</span> or <span class="apiname">CWBSO_CopyObjHandle</span> must
be called prior to calling this API. The object handle that is returned by <span class="apiname">CWBSO_GetObjHandle</span> or <span class="apiname">CWBSO_CopyObjHandle</span> must be passed as input to this API. When the object 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>