83 lines
4.4 KiB
HTML
83 lines
4.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="reference" />
|
||
|
|
<meta name="DC.Title" content="cwbUP_CreateUpdateEntry" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikufapilist1.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="cwbup_createupdateentry" />
|
||
|
|
<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>cwbUP_CreateUpdateEntry</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbup_createupdateentry"><a name="cwbup_createupdateentry"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbUP_CreateUpdateEntry</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Creates a new update entry and passes back
|
||
|
|
a handle to it.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbUP_CreateUpdateEntry(
|
||
|
|
char * entryDescription,
|
||
|
|
char * entrySource,
|
||
|
|
char * entryTarget,
|
||
|
|
cwbUP_EntryHandle *entryHandle);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">char * entryDescription - input</dt>
|
||
|
|
<dd>Points to a null-terminated string that contains a description to identify
|
||
|
|
the update entry.</dd>
|
||
|
|
<dt class="dlterm">char * entrySource - input</dt>
|
||
|
|
<dd>Points to a null-terminated string that contains the source for the update
|
||
|
|
entry. This can be either a drive and path, or a UNC name.</dd>
|
||
|
|
<dt class="dlterm">char * entryTarget - input</dt>
|
||
|
|
<dd>Points to a null-terminated strings that contains the target for the update
|
||
|
|
entry. This can be either a drive and path, or a UNC name.</dd>
|
||
|
|
<dt class="dlterm">cwbUP_EntryHandle * entryHandle - input/output</dt>
|
||
|
|
<dd>Pointer to a <span class="apiname">cwbUP_EntryHandle</span> where the handle will
|
||
|
|
be returned. This handle must be used in subsequent calls to the update entry
|
||
|
|
APIs.</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_POINTER</dt>
|
||
|
|
<dd>NULL passed as an address.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory to create handle.</dd>
|
||
|
|
<dt class="dlterm">CWBUP_TOO_MANY_ENTRIES</dt>
|
||
|
|
<dd>The maximum number of update entries already exist. No more can be created.</dd>
|
||
|
|
<dt class="dlterm">CWBUP_STRING_TOO_LONG</dt>
|
||
|
|
<dd>An input string is longer than the maximum of CWBUP_MAX_LENGTH.</dd>
|
||
|
|
<dt class="dlterm">CWBUP_ENTRY_IS_LOCKED</dt>
|
||
|
|
<dd>Another application is currently changing the update entry list. No changes
|
||
|
|
are allowed at this time.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>When you use this call, and have completed
|
||
|
|
your processing of the update entry, you must call <span class="apiname">cwbUP_FreeEntryHandle</span>.
|
||
|
|
This call will "unlock" the entry, and free resources that are associated
|
||
|
|
with it.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikufapilist1.htm" title="The following iSeries Access for Windows Directory Update are used to create and delete an update entry. The APIs are listed alphabetically.">Directory Update: Create and delete APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|