<?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_SetMessageComponent" /> <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_setmessagecomponent" /> <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_SetMessageComponent</title> </head> <body id="cwbsv_setmessagecomponent"><a name="cwbsv_setmessagecomponent"><!-- --></a> <!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script> <h1 class="topictitle1">cwbSV_SetMessageComponent</h1> <div><div class="section"><h4 class="sectiontitle">Purpose</h4> <p>This function allows setting of a unique component identifier in the message handle that is provided. Along with setting the product ID (see cwbSV_SetMessageProduct), this call should be used to distinguish your message entries from other product's entries in the history log.</p> </div> <div class="section"><h4 class="sectiontitle">Syntax</h4> <pre> unsigned int CWB_ENTRY cwbSV_SetMessageComponent( cwbSV_MessageTextHandle messageTextHandle, char *componentID);</pre> </div> <div class="section"><h4 class="sectiontitle">Parameters</h4> <dl><dt class="dlterm">cwbSV_MessageTextHandle messageTextHandle - input</dt> <dd>Handle that was returned by a previous call to cwbSV_CreateMessageTextHandle().</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. NOTE: A maximum of CWBSV_MAX_COMP_ID characters will be logged for the component ID. Larger strings will be truncated.</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_HANDLE</dt> <dd>Unusable handle passed in on request.</dd> </dl> </div> <div class="section"><h4 class="sectiontitle">Usage</h4> <p>This value should be set before calling the corresponding log function, "cwbSV_LogMessageData()". The suggested hierarchy is that you would define a product ID with one or many components that are defined under it.</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>