ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaikcwbsvgettraceapiid.htm

72 lines
3.6 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?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_GetTraceAPIID" />
<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_gettraceapiid" />
<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_GetTraceAPIID</title>
</head>
<body id="cwbsv_gettraceapiid"><a name="cwbsv_gettraceapiid"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">cwbSV_GetTraceAPIID</h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4>
<p>Returns the API event ID of the service record object that is identified
by the handle that is provided.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4>
<pre>
unsigned int CWB_ENTRY cwbSV_GetTraceAPIID(
cwbSV_ServiceRecHandle serviceRecHandle,
char *apiID);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4>
<dl><dt class="dlterm">cwbSV_ServiceRecHandle serviceRecHandle - input</dt>
<dd>Handle that was returned by a previous call to the cwbSV_CreateServiceRecHandle()
function.</dd>
<dt class="dlterm">char * apiID - input/output</dt>
<dd>Pointer to one-byte field that receives the API event ID.</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 on output parameter.</dd>
<dt class="dlterm">CWB_INVALID_HANDLE</dt>
<dd>Handle is not valid.</dd>
<dt class="dlterm">CWBSV_INVALID_RECORD_TYPE</dt>
<dd>Type is not CWBSV_API_TRACE_REC.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4>
<p>If the record type is not CWBSV_API_TRACE_REC, a return code of CWBSV_INVALID_RECORD_TYPE
will be returned. (note: cwbSV_GetServiceType() returns the current record
type)</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>