117 lines
6.3 KiB
HTML
117 lines
6.3 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="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_OpenResourceForSplF" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist6.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_openresourceforsplf" />
|
||
|
|
<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_OpenResourceForSplF</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbobj_openresourceforsplf"><a name="cwbobj_openresourceforsplf"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbOBJ_OpenResourceForSplF</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Opens an AFP™ Resource object for reading for a spooled
|
||
|
|
file that is already opened for reading. The API is useful if you are reading
|
||
|
|
an AFP Spooled
|
||
|
|
file and run into an external AFP Resource that you need to read. By using
|
||
|
|
this API you can open that resource for reading without having to first list
|
||
|
|
the resource.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbOBJ_OpenResourceForSplF(
|
||
|
|
cwbOBJ_ObjHandle splFHandle,
|
||
|
|
const char *resourceName,
|
||
|
|
const char *resourceLibrary,
|
||
|
|
unsigned long resourceType,
|
||
|
|
const char *reserved,
|
||
|
|
cwbOBJ_ObjHandle *resourceHandle,
|
||
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbOBJ_ObjHandle splFHandle - input</dt>
|
||
|
|
<dd>Handle of the spooled file that is already opened for reading and that
|
||
|
|
the resource will be opened against. The same conversation (and same instance
|
||
|
|
of the network print server program on the iSeries™ server) will be used for reading
|
||
|
|
the resource and spooled file.</dd>
|
||
|
|
<dt class="dlterm">const char *resourceName - input</dt>
|
||
|
|
<dd>Pointer to the name of the AFP Resource in an ASCIIZ string.</dd>
|
||
|
|
<dt class="dlterm">const char *resourceLibrary - input</dt>
|
||
|
|
<dd>Optional, may be NULL. Pointer to the iSeries library of the AFP Resource in
|
||
|
|
an ASCIIZ string. If no library is specified, the library list of the spooled
|
||
|
|
file is used to search for the resource.</dd>
|
||
|
|
<dt class="dlterm">unsigned long resourceType - input</dt>
|
||
|
|
<dd> An unsigned long integer with one of the following bits on: <ul><li>CWBOBJ_AFPRSC_FONT</li>
|
||
|
|
<li>CWBOBJ_AFPRSC_FORMDEF</li>
|
||
|
|
<li>CWBOBJ_AFPRSC_OVERLAY</li>
|
||
|
|
<li>CWBOBJ_AFPRSC_PAGESEG</li>
|
||
|
|
<li>CWBOBJ_AFPRSC_PAGEDEF</li>
|
||
|
|
</ul>
|
||
|
|
Specifies what type of resource to open.</dd>
|
||
|
|
<dt class="dlterm">const char *reserved -</dt>
|
||
|
|
<dd>Reserved, must be NULL.</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_OBJHandle *resourceHandle - output</dt>
|
||
|
|
<dd>Pointer to an OBJHandle that on successful return will contain the dynamically
|
||
|
|
allocated resource handle that can be used to read, seek and eventually close
|
||
|
|
the resource.</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_FILE_NOT_FOUND</dt>
|
||
|
|
<dd>The resource wasn't found.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory; may have failed to allocate temporary buffer.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_HANDLE</dt>
|
||
|
|
<dd>Handle is not valid resource handle.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_PARAMETER</dt>
|
||
|
|
<dd>Invalid parameter specified.</dd>
|
||
|
|
<dt class="dlterm">CWBOBJ_RC_HOST_ERROR</dt>
|
||
|
|
<dd>Host error occurred. Text may be in errorHandle.</dd>
|
||
|
|
<dt class="dlterm">CWBOBJ_RC_SPLFNOTOPEN</dt>
|
||
|
|
<dd>The spooled file is not opened.</dd>
|
||
|
|
<dt class="dlterm">CWBOBJ_RC_NOHOSTSUPPORT</dt>
|
||
|
|
<dd>Host doesn't support working with resources.</dd>
|
||
|
|
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
|
||
|
|
<dd>One or more input Unicode characters have no representation in the code
|
||
|
|
page being used.</dd>
|
||
|
|
<dt class="dlterm">CWB_API_ERROR</dt>
|
||
|
|
<dd>General API failure.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This call, if successful, will generate a
|
||
|
|
temporary resource handle and return it in the resourceHandle parameter.
|
||
|
|
This handle will be deleted automatically when the caller calls the <span class="apiname">cwbOBJ_CloseResource()</span> API
|
||
|
|
with it.</p>
|
||
|
|
<p>The resource should be closed with the <span class="apiname">cwbOBJ_CloseResource()</span>)
|
||
|
|
API when done reading from it.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikobjapilist6.htm" title="The following iSeries Access for Windows APIs pertain to AFP resources. The APIs are listed alphabetically.">AFP resource APIs for iSeries Access for Windows</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|