ibm-information-center/dist/eclipse/plugins/i5OS.ic.apiref_5.4.0.1/cmnFormat.htm

57 lines
3.4 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="concept" />
<meta name="DC.Title" content="API format" />
<meta name="abstract" content="The format section in API information describes a format name." />
<meta name="description" content="The format section in API information describes a format name." />
<meta name="DC.Relation" scheme="URI" content="cmnCommon.htm" />
<meta name="DC.Relation" scheme="URI" content="../apis/qwdrjobd.htm" />
<meta name="DC.Relation" scheme="URI" content="listGeneral.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="cmnFormat" />
<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>API format</title>
</head>
<body id="cmnFormat"><a name="cmnFormat"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">API format</h1>
<div><p>The format section in API information describes a format name.</p>
<p>For example, for the Retrieve Job Description (QWDRJOBD)
API, the format described is JOBD0100 Format. Listed within the format are
the individual fields that contain the attributes of the job description.
The offset in the <em>Dec</em> (decimal offset) column for the hold on job queue
field (hold parameter on the Retrieve Job Description command) begins at decimal
offset 76.</p>
<p>The fields in the format do not occur in any particular sequence. You have
to scan the format to determine what you want.</p>
<p>The Retrieve Job Description (QWDRJOBD) API has only a single format; other
APIs may have multiple formats where each format has different levels of information.
With multiple formats, a format name parameter allows you to specify which
format you want to retrieve.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="cmnCommon.htm" title="API names contain verbs that are similar to the i5/OS licensed program: change, create, remove, and retrieve.">API information format</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="../apis/qwdrjobd.htm">Retrieve Job Description (QWDRJOBD) API</a></div>
<div><a href="listGeneral.htm" title="Describes some of the more important fields that comprise the general data structure.">List Object API general data structure</a></div>
</div>
</div>
</body>
</html>