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

84 lines
4.6 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="cwbNL_LoadDialogStrings" />
<meta name="DC.Relation" scheme="URI" content="rzaikdialogboxnlsapilist.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="cwbnl_loaddialogstrings" />
<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>cwbNL_LoadDialogStrings</title>
</head>
<body id="cwbnl_loaddialogstrings"><a name="cwbnl_loaddialogstrings"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbNL_LoadDialogStrings</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This routine will control the replacement
of translatable text within a dialog box. This includes dialog control text
as well as the dialog-box caption.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbNL_LoadDialogStrings(
HINSTANCE MRIHandle,
HWND windowHandle,
int nCaptionID,
USHORT menuID,
HINSTANCE menuLibHandle,
cwb_Boolean growAllControls);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">HINSTANCE MRIHandle - input</dt>
<dd>Handle of the module containing the strings for the dialog.</dd>
<dt class="dlterm">HWND windowHandle - input</dt>
<dd>Window handle of the dialog box.</dd>
<dt class="dlterm">int nCaptionID - input</dt>
<dd>ID of the caption string for the dialog box</dd>
<dt class="dlterm">USHORT menuID - input</dt>
<dd>ID of the menu for the dialog box.</dd>
<dt class="dlterm">HINSTANCE menuLibHandle - input</dt>
<dd>Handle of the module containing the menu for the dialog.</dd>
<dt class="dlterm">cwb_Boolean growAllControls - input</dt>
<dd>CWB_TRUE = All controls will be resized by the growthFactor CWB_FALSE
= Only controls with text will be resized.</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">CWBNL_DLG_MENU_LOAD_ERROR</dt>
<dd>Could not load the menu.</dd>
<dt class="dlterm">CWBNL_DLG_INVALID_HANDLE</dt>
<dd>Incorrect MRIHandle.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This process begins by enumerating,
replacing the text of, and horizontally adjusting, all dialog controls within
the dialog box, and finally right-adjusting the dialog box itself, relative
to the adjusted controls therein. These adjustments are made only if the current
window extents do not fully encompass the expansion space required for the
text or all controls. After all of the text substitution has been completed,
if a menu ID has been passed, it will be loaded and attached to the dialog
box. It is suggested that this routine is called for every dialog-box procedure
as the first thing done during the INITDLG message processing.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikdialogboxnlsapilist.htm" title="iSeries Access for Windows dialog-box NLS APIs are interfaces that are used to manipulate the translatable text within dialog boxes.">iSeries Access for Windows dialog-box NLS API list</a></div>
</div>
</div>
</body>
</html>