77 lines
4.0 KiB
HTML
77 lines
4.0 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="cwbSV_OpenServiceFile" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapilist4.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="cwbsv_openservicefile" />
|
|
<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>cwbSV_OpenServiceFile</title>
|
|
</head>
|
|
<body id="cwbsv_openservicefile"><a name="cwbsv_openservicefile"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">cwbSV_OpenServiceFile</h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4>
|
|
<p>Opens the specified service file for READ access (history log, trace file,
|
|
and so forth) and returns a handle to it.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4>
|
|
<pre>
|
|
unsigned int CWB_ENTRY cwbSV_OpenServiceFile(
|
|
char *serviceFileName,
|
|
cwbSV_ServiceFileHandle *serviceFileHandle,
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4>
|
|
<dl><dt class="dlterm">char * serviceFileName - input</dt>
|
|
<dd>Points to a buffer that contains the fully-qualified name (for example,
|
|
c:\path\filename.ext) of the service file to open.</dd>
|
|
<dt class="dlterm">cwbSV_ServiceFileHandle * serviceFileHandle - input/output</dt>
|
|
<dd>Pointer to a cwbSV_ServiceFileHandle where the handle will be returned.
|
|
This handle should be used in subsequent calls to the service file functions.</dd>
|
|
<dt class="dlterm">cwbSV_ErrHandle errorHandle - output</dt>
|
|
<dd>Any returned messages will be written to this object. It is created
|
|
with the cwbSV_CreateErrHandle API. The messages may be retrieved through
|
|
the cwbSV_GetErrText API. If the parameter is set to zero, no messages will
|
|
be retrieved.</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_INVALID_POINTER</dt>
|
|
<dd>NULL passed as handle address.</dd>
|
|
<dt class="dlterm">CWB_FILE_IO_ERROR</dt>
|
|
<dd>File could not be opened.</dd>
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
|
<dd>Insufficient memory to create handle.</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="rzaiksvcapilist4.htm" title="Use these APIs to read service files, service file records, and service file header information. Additionally, you can read history log service records, detail trace file service records, and entry/exit trace file service records.">Serviceability API list: Reading service files</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |