93 lines
5.1 KiB
HTML
93 lines
5.1 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_DisplayResource" />
|
|
<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_displayresource" />
|
|
<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_DisplayResource</title>
|
|
</head>
|
|
<body id="cwbobj_displayresource"><a name="cwbobj_displayresource"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1"><span class="apiname">cwbOBJ_DisplayResource</span></h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Displays the specified AFP™ resource to
|
|
the user.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
|
unsigned int CWB_ENTRY cwbOBJ_DisplayResource(
|
|
cwbOBJ_ObjHandle resourceHandle,
|
|
const char *view,
|
|
const unsigned long flags,
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbOBJ_ObjHandle resourceHandle - input</dt>
|
|
<dd>Handle of the AFP Resource object. It must be an overlay or a pagesegment
|
|
type of resource.</dd>
|
|
<dt class="dlterm">const char *view - input</dt>
|
|
<dd>Optional, may be NULL. If specified, it is a pointer to an ASCIIZ string
|
|
that specifies the view to use when invoking the AFP viewer. There are two predefined views
|
|
shipped with the viewer: LETTER (8.5" x 11") and SFLVIEW (132 column). Users
|
|
may also add their own.</dd>
|
|
<dt class="dlterm">const unsigned long flags - input</dt>
|
|
<dd>Any of following bits may be set: CWBOBJ_DSPSPLF_WAIT - instructs this
|
|
call to wait until the viewer process has successfully opened the resource
|
|
before returning. If this bit is 0, this API will return after it starts the
|
|
viewer process. If it is 1, this API will wait for the viewer to get the resource
|
|
open before returning. All other bits must be set to 0.</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_OK </dt>
|
|
<dd>Successful completion.</dd>
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY </dt>
|
|
<dd>Insufficient memory; may have failed to allocate a temporary buffer.</dd>
|
|
<dt class="dlterm">CWB_INVALID_HANDLE </dt>
|
|
<dd>Handle is not an allocated object handle.</dd>
|
|
<dt class="dlterm">CWB_NO_VIEWER </dt>
|
|
<dd>The viewer support for ClientAccess/400 was not installed.</dd>
|
|
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR </dt>
|
|
<dd>One or more input Unicode characters have no representation in the code
|
|
page that is being used.</dd>
|
|
<dt class="dlterm">CWB_API_ERROR </dt>
|
|
<dd>General API failure.</dd>
|
|
<dt class="dlterm">CWBOBJ_RC_INVALID_TYPE </dt>
|
|
<dd>The handle given for resourceHandle is not a handle to an overlay or pagesegment
|
|
resource.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>Use this API to bring up the AFP viewer on the
|
|
specified AFP resource.
|
|
The type of the resource must be an overlay or a pagesegment. A return code
|
|
of CWB_NO_VIEWER means that the viewer component was not installed on the
|
|
workstation.</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> |