<?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="cwbOBJ_GetObjHandleFromID" />
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist2.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="cwbobj_getobjhandlefromid" />
<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>cwbOBJ_GetObjHandleFromID</title>
</head>
<body id="cwbobj_getobjhandlefromid"><a name="cwbobj_getobjhandlefromid"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbOBJ_GetObjHandleFromID</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Regenerate an object handle from it's binary
ID and type. <span class="apiname">cwbOBJ_DeleteObjHandle()</span> must be called to
free resources when you are done using the object handle.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbOBJ_GetObjHandleFromID(
void *idBuffer,
unsigned long bufLen,
cwbOBJ_ObjType objectType,
cwbOBJ_ObjHandle *objectHandle,
cwbSV_ErrHandle errorHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">void *idBuffer - input</dt>
<dd>The buffer that holds the id of this object.</dd>
<dt class="dlterm">unsigned long bufLen - input</dt>
<dd>The length of the data pointed to by pIDBuffer.</dd>
<dt class="dlterm">cwbOBJ_ObjType type - input</dt>
<dd>Type of object this ID is for. This must match the type of object the
ID was taken from.</dd>
<dt class="dlterm">cwbOBJ_ObjHandle *objectHandle - output</dt>
<dd>If this call returns successfully, this will be the handle to the object.
This handle should be released with the <span class="apiname">cwbOBJ_DeleteObjHandle()</span> API
when done using it.</dd>
<dt class="dlterm">cwbSV_ErrHandle errorHandle - output</dt>
<dd>Optional, may be 0. Any returned messages will be written to this object.
It is created with the <span class="apiname">cwbSV_CreateErrHandle()</span> API. The
messages may be retrieved through the <span class="apiname">cwbSV_GetErrText()</span> API.
If the parameter is set to zero, no messages will be retrievable.</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_NO_ERROR</dt>
<dd>Successful completion.</dd>
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
<dd>Insufficient memory.</dd>
<dt class="dlterm">CWB_INVALID_HANDLE</dt>
<dd>Handle is not an allocated object handle.</dd>
<dt class="dlterm">CWB_INVALID_PARAMETER</dt>
<dd>Invalid parameter specified.</dd>
<dt class="dlterm">CWBOBJ_RC_INVALID_TYPE</dt>
<dd>objectType is not correct.</dd>
<dt class="dlterm">CWBOBJ_RC_HOST_ERROR</dt>
<dd>Host error occurred. Text may be in errorHandle.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>None</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikobjapilist2.htm" title="The following iSeries Access for Windows APIs pertain to Objects. The APIs are listed alphabetically.">Object APIs for iSeries Access for Windows</a></div>
</div>
</div>
</body>
</html>