ibm-information-center/dist/eclipse/plugins/i5OS.ic.cli_5.4.0.1/rzadpstringlength.htm

60 lines
3.8 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?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="Length of string arguments in DB2 UDB CLI functions" />
<meta name="DC.subject" content="string arguments, character strings, SQL_NTS, null-terminated strings" />
<meta name="keywords" content="string arguments, character strings, SQL_NTS, null-terminated strings" />
<meta name="DC.Relation" scheme="URI" content="rzadpstringarguments.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="rzadpstringlength" />
<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>Length of string arguments in DB2 UDB CLI functions</title>
</head>
<body id="rzadpstringlength"><a name="rzadpstringlength"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Length of string arguments in DB2 UDB CLI functions</h1>
<div><p>Input string arguments have an associated length argument. This argument
indicates to DB2<sup>®</sup> UDB
CLI, either the length of the allocated buffer (not including the null byte
terminator), or the special value SQL_NTS. If SQL_NTS is passed, DB2 UDB CLI determines
the length of the string by locating the null terminating character.</p>
<p>Output string arguments have two associated length arguments, one to specify
the length of the allocated buffer and one to return the length of the string
returned by DB2 UDB
CLI. The returned length value is the total length of the string available
for return, whether it fits in the buffer or not.</p>
<p>For SQL column data, if the output is an empty string, SQL_NULL_DATA is
returned in the length argument.</p>
<p>If a function is called with a null pointer for an output length argument, DB2 UDB
CLI does not return a length. This might be useful when it is known that the
buffers are large enough for all possible results. If DB2 UDB CLI attempts to return the SQL_NULL_DATA
value to indicate a column contains null data and the output length argument
is a null pointer, the function call fails.</p>
<p>Every character string that DB2 UDB CLI returns is terminated with a
null terminating character (hexadecimal 00), except for strings
that are returned from graphic data types. This requires that all buffers
allocate enough space for the maximum number that are expected, plus one for
the null-terminating character.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzadpstringarguments.htm" title="These topics discuss some conventions when dealing with the various aspects of working with string arguments in DB2 UDB CLI functions.">Work with string arguments in DB2 UDB CLI functions</a></div>
</div>
</div>
</body>
</html>