ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/crtlocale.htm

385 lines
15 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Create Locale (CRTLOCALE)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="CRTLOCALE.Top_Of_Page"></a>
<h2>Create Locale (CRTLOCALE)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#CRTLOCALE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CRTLOCALE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CRTLOCALE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CRTLOCALE"></a>
<p>The Create Locale (CRTLOCALE) command creates a locale object (*LOCALE) using the source information from the file provided on the SRCFILE parameter.
</p>
<p>A locale is an object that can determine how data is processed, printed, and displayed. Locales are made up of categories that define language, cultural data, and character sets. Locales, in the form of a system object, are not shipped with the operating system. Rather, the locale definition source files are provided.
</p>
<p>For more information about locales, see the Globalization information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
</p>
<p><b>Restriction</b>
</p>
<p>Locales must be created in the QSYS file system.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CRTLOCALE.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#CRTLOCALE.LOCALE"><b>LOCALE</b></a></td>
<td valign="top">Locale name</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#CRTLOCALE.SRCFILE"><b>SRCFILE</b></a></td>
<td valign="top">Source file path name</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#CRTLOCALE.CCSID"><b>CCSID</b></a></td>
<td valign="top">Coded character set ID</td>
<td valign="top">1-65533, *JOB, *UTF</td>
<td valign="top">Required, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#CRTLOCALE.GENLVL"><b>GENLVL</b></a></td>
<td valign="top">Generation severity level</td>
<td valign="top"><b><u>10</u></b>, 20</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTLOCALE.TEXT"><b>TEXT</b></a></td>
<td valign="top">Text 'description'</td>
<td valign="top"><i>Character value</i>, <b><u>*BLANK</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTLOCALE.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*PRINT</u></b>, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CRTLOCALE.OPTION"><b>OPTION</b></a></td>
<td valign="top">Source listing options</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Source listing</td>
<td valign="top">
<i>Integer</i>, <b><u>*SRC</u></b>, *NOSRC</td>
</tr>
<tr>
<td valign="top">Element 2: Second level messages</td>
<td valign="top">
<i>Integer</i>, *SECLVL, <b><u>*NOSECLVL</u></b></td>
</tr>
<tr>
<td valign="top"><a href="#CRTLOCALE.REPLACE"><b>REPLACE</b></a></td>
<td valign="top">Replace object</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTLOCALE.DTAAUT"><b>DTAAUT</b></a></td>
<td valign="top">Public authority for data</td>
<td valign="top"><i>Name</i>, <b><u>*INDIR</u></b>, *NONE, *RWX, *RX, *RW, *WX, *R, *W, *X, *EXCLUDE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTLOCALE.OBJAUT"><b>OBJAUT</b></a></td>
<td valign="top">Public authority for object</td>
<td valign="top">Single values: <b><u>*INDIR</u></b>, *NONE, *ALL<br>Other values (up to 4 repetitions): *OBJEXIST, *OBJMGT, *OBJALTER, *OBJREF</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CRTLOCALE.LOCALE"></a>
<h3>Locale name (LOCALE)</h3>
<p>Specifies the path name of the locale being created.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTLOCALE.SRCFILE"></a>
<h3>Source file path name (SRCFILE)</h3>
<p>Specifies the path name of the source file that contains the description of the locale being created. If the CCSID of the file is 65535, the job default CCSID is assumed by this command. If the file is from the QSYS file system, then it must be a database source physical file.
</p>
<p>
<b>Note: </b>If the source file is not a record file, then each line in the source file must have been terminated with a newline or linefeed character when the source file was created.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTLOCALE.CCSID"></a>
<h3>Coded character set ID (CCSID)</h3>
<p>Specifies the coded character set ID (CCSID) in which to store the locale information for the locale object.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*JOB</b></dt>
<dd>Specifies that the job CCSID is used for the locale information. If the job CCSID is 65535, the job default CCSID is used.
</dd>
<dt><b>*UTF</b></dt>
<dd>Specifies that two locales will be created, one for UTF8 and one for UTF32. The UTF8 locale name will have _8 appended to the specified locale name. The UTF32 locale name will have _4 appended to the specified locale name. The locale name specified will be limited to 8 characters in length when CCSID(*UTF) is specified.
</dd>
<dt><b><i>coded-character-set-ID</i></b></dt>
<dd>Specify the CCSID used for the locale information.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTLOCALE.GENLVL"></a>
<h3>Generation severity level (GENLVL)</h3>
<p>Specifies the severity level at which the creation operation can be controlled. The severity level of the messages generated in the creation operation indicate the type of errors that have occurred.
</p>
<p>
<b>Note: </b>If errors occur with a severity level greater than 20, the locale is not created.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>10</u></b></dt>
<dd>The locale is created with level 10 severity errors.
</dd>
<dt><b>20</b></dt>
<dd>The locale is created with level 20 severity errors.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTLOCALE.TEXT"></a>
<h3>Text 'description' (TEXT)</h3>
<p>Specifies the text that briefly describes the locale.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*BLANK</u></b></dt>
<dd>Text is not specified.
</dd>
<dt><b><i>'description'</i></b></dt>
<dd>Specify no more than 50 characters of text, enclosed in apostrophes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTLOCALE.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether or not a compiler listing is produced.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*PRINT</u></b></dt>
<dd>The compiler listing is produced. The information contained in the listing depends on the values specified on the OPTION parameter.
</dd>
<dt><b>*NONE</b></dt>
<dd>The compiler listing is not produced. To improve compile-time performance, this value should be specified when a listing is not required.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTLOCALE.OPTION"></a>
<h3>Source listing options (OPTION)</h3>
<p>Specifies the types of output lists created when this command is processed.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*SRC</u></b></dt>
<dd>The source input used to create the locale is printed.
</dd>
<dt><b>*NOSRC</b></dt>
<dd>The source input used to create the locale is not printed.
</dd>
<dt><b><u>*NOSECLVL</u></b></dt>
<dd>Only the first-level error message text is included in the source listing.
</dd>
<dt><b>*SECLVL</b></dt>
<dd>Second-level error message text is printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTLOCALE.REPLACE"></a>
<h3>Replace object (REPLACE)</h3>
<p>Specifies whether an existing version of the locale is replaced by the current locale.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>The existing locale is replaced with the new version. The old version is moved to the library QRPLOBJ and renamed based on the system date and time. The text description of the original locale is not used as the text description for the new locale. The old locale is deleted at the next IPL or you can use the Delete Locale (DLTLOCALE) command to delete it.
</dd>
<dt><b>*NO</b></dt>
<dd>The local is not replaced and an error message is issued.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTLOCALE.DTAAUT"></a>
<h3>Public authority for data (DTAAUT)</h3>
<p>Specifies the public authority given users for the data in the object created.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*INDIR</u></b></dt>
<dd>The authority for the object being created is determined by the directory it is being created in. If *INDIR is used for DTAAUT, it is also required for OBJAUT.
</dd>
<dt><b>*RWX</b></dt>
<dd>The users are given *RWX authority to the objects. *RWX authority allows the user to perform all operations on the object except those limited to the owner or controlled by object existence, object management, object alter, and object reference authority. The user can change the object and perform basic functions on the object. *RWX authority provides object operational authority and all the data authorities.
</dd>
<dt><b>*RX</b></dt>
<dd>*RX authority allows the user to perform basic operations on the object, such as run a program or display the contents of a file. The user is prevented from changing the object. *RX authority provides object operational authority and read and execute authorities.
</dd>
<dt><b>*RW</b></dt>
<dd>*RW authority allows the user to view the contents of an object and modify the contents of an object. *RW authority provides object operational authority and data read, add, update, and delete authorities.
</dd>
<dt><b>*WX</b></dt>
<dd>*WX authority allows the user to modify the contents of an object and run a program or search a library or directory. *WX authority provides object operational authority and data add, update, delete, and execute authorities.
</dd>
<dt><b>*R</b></dt>
<dd>*R authority allows the user to view the contents of an object. *R authority provides object operational authority and data read authority.
</dd>
<dt><b>*W</b></dt>
<dd>*W authority allows the user to modify the contents of an object. *W authority provides object operational authority and data add, update, and delete authorities.
</dd>
<dt><b>*X</b></dt>
<dd>*X authority allows the user to run a program or search a library or directory. *X authority provides object operational authority and data execute authority.
</dd>
<dt><b>*EXCLUDE</b></dt>
<dd>Exclude authority prevents the user from accessing the object. The OBJAUT value must be *NONE if this special value is used.
</dd>
<dt><b>*NONE</b></dt>
<dd>The users will not be given any of the data authorities to the objects. This value cannot be used with OBJAUT value of *NONE.
</dd>
<dt><b><i>authorization-list-name</i></b></dt>
<dd>Specify the name of the authorization list used.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTLOCALE.OBJAUT"></a>
<h3>Public authority for object (OBJAUT)</h3>
<p>Specifies the authorities given users to the object.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*INDIR</u></b></dt>
<dd>The object authority is based on the authority for the directory where this object is being created. If *INDIR is used for DTAAUT, it is also required for OBJAUT.
</dd>
<dt><b>*NONE</b></dt>
<dd>None of the other object authorities (existence, management, alter, or reference) will be given to the users. If *EXCLUDE or an authorization list name is specified for the DTAAUT parameter, this value must be specified.
</dd>
<dt><b>*ALL</b></dt>
<dd>All of the other object authorities (existence, management, alter, and reference) will be given to the users.
<p>Or specify up to four (4) of the following values:
</p>
</dd>
<dt><b>*OBJEXIST</b></dt>
<dd>The users will be given object existence authority to the object.
</dd>
<dt><b>*OBJMGT</b></dt>
<dd>The users will be given object management authority to the object.
</dd>
<dt><b>*OBJALTER</b></dt>
<dd>The users will be given object alter authority to the object.
</dd>
<dt><b>*OBJREF</b></dt>
<dd>The users will be given object reference authority to the object.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CRTLOCALE.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
CRTLOCALE LOCALE('/QSYS.LIB/MYLIB.LIB/USLOCALE.LOCALE')
SRCFILE('/QSYS.LIB/MYLIB.LIB/LSRC.FILE/USLOCALE.MBR')
CCSID(37) TEXT('Locale for USA')
</pre>
</p>
<p>This command creates a locale named USLOCALE in the library called MYLIB in the QSYS.LIB file system with a CCSID of 37. The text parameter describes this as a locale for the USA.
</p>
<p>
<pre>
CRTLOCALE LOCALE('/QSYS.LIB/MYLIB.LIB/USLOCALE.EXAMPLE')
SRCFILE('/QSYS.LIB/MYLIB.LIB/LSRC.FILE/EXAMPLE.MBR')
CCSID(*UTF)) TEXT('UTF Locale examples')
</pre>
</p>
<p>This command creates two locales named EXAMPLE_4 with a CCSID of 1232 and EXAMPLE_8 with a CCSID of 1208 in the library called MYLIB in the QSYS.LIB file system. The text parameter describes them as UTF locale examples.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CRTLOCALE.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF3BE1</b></dt>
<dd>Locale object &amp;1 not created.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTLOCALE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>