81 lines
4.3 KiB
HTML
81 lines
4.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="cwbSV_CreateMessageTextHandle" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapilist1.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_createmessagetexthandle" />
|
||
|
|
<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_CreateMessageTextHandle</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbsv_createmessagetexthandle"><a name="cwbsv_createmessagetexthandle"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">cwbSV_CreateMessageTextHandle</h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4>
|
||
|
|
<p>This function creates a message text object and returns a handle to it.
|
||
|
|
This message handle can be used in your program to write message text to the
|
||
|
|
currently active history log. The message text is supplied in a buffer passed
|
||
|
|
on the cwbSV_LogMessageText() call.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4>
|
||
|
|
<pre>
|
||
|
|
unsigned int CWB_ENTRY cwbSV_CreateMessageTextHandle(
|
||
|
|
char *productID,
|
||
|
|
char *componentID,
|
||
|
|
cwbSV_MessageTextHandle *messageTextHandle);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4>
|
||
|
|
<dl><dt class="dlterm">char * productID - input</dt>
|
||
|
|
<dd>Points to a null-terminated string that contains a product identifier
|
||
|
|
to be used on this message entry. Parameter is optional, if null, no productID
|
||
|
|
is set. NOTE: A maximum of CWBSV_MAX_PRODUCT_ID characters will be logged
|
||
|
|
for the product ID. Larger strings will be truncated.</dd>
|
||
|
|
<dt class="dlterm">char * componentID - input</dt>
|
||
|
|
<dd>Points to a null-terminated string that contains a component identifier
|
||
|
|
to be used on this message entry. Parameter is optional, if null, no componentID
|
||
|
|
is set. NOTE: A maximum of CWBSV_MAX_COMP_ID characters will be logged for
|
||
|
|
the component ID. Larger strings will be truncated.</dd>
|
||
|
|
<dt class="dlterm">cwbSV_MessageTextHandle * messageTextHandle - input/output</dt>
|
||
|
|
<dd>Pointer to a cwbSV_MessageTextHandle where the handle will be returned.
|
||
|
|
This handle should be used in subsequent calls to the message text functions.</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_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory to create handle.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4>
|
||
|
|
<p>It is recommended that you set a unique product ID and component ID in
|
||
|
|
the message handle before using it to log message text. These ID's will distinguish
|
||
|
|
your messages from other messages in the history log.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksvcapilist1.htm" title="Use these APIs to write message text to a history log">Serviceability APIs list: Writing to history log</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|