ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzakx_5.4.0.1/rzakxcwbungetldappublishser.htm

80 lines
3.7 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="copyright" content="(C) Copyright IBM Corporation 2005" />
<meta name="DC.rights.owner" content="(C) Copyright IBM Corporation 2005" />
<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="cwbUN_GetLdapPublishServer" />
<meta name="DC.Relation" scheme="URI" content="rzakxapis.htm" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzakxcwbungetldappublishser" />
<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>cwbUN_GetLdapPublishServer</title>
</head>
<body id="rzakxcwbungetldappublishser"><a name="rzakxcwbungetldappublishser"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">cwbUN_GetLdapPublishServer</h1>
<div><p><strong>Purpose</strong></p>
<p>Returns the name of the server to which this information is published.</p>
<p><strong>Syntax</strong></p>
<pre>int cwbUN_GetLdapPublishServerW
( cwbUN_ldapPubHandle handle,
int index,
LPWSTR server,
int *length
);
int cwbUN_GetLdapPublishServerA
( cwbUN_ldapPubHandle handle,
int index,
LPSTR server,
int *length
);</pre>
<p><strong>Parameters</strong></p>
<dl><dt class="dlterm">cwbUN_ldapPubHandle handle - input</dt>
<dd>A handle previously obtained by a call to cwbUN_OpenLdapPublishing().</dd>
<dt class="dlterm">int index - input</dt>
<dd>Zero-based index of the publish record. This value must be less than the
count returned by cwbUN_GetLdapPublishCount().</dd>
<dt class="dlterm">LPSTR server - output</dt>
<dd>Pointer to the buffer that will contain the name of the server.</dd>
<dt class="dlterm">int * length - input/output</dt>
<dd>Pointer to the length of the server buffer. If the buffer is too small
to hold the string, including space for the terminating NULL, the size of
the buffer needed will be filled into this parameter.</dd>
</dl>
<p><strong>Return Codes</strong></p>
<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_API_HANDLE</dt>
<dd>Invalid handle.</dd>
<dt class="dlterm">CWB_INVALID_API_PARAMETER</dt>
<dd>Invalid index.</dd>
<dt class="dlterm">CWB_INVALID_POINTER</dt>
<dd>A NULL pointer was specified.</dd>
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
<dd>The suffix buffer is not large enough to hold the entire result.</dd>
</dl>
<p><strong>Usage</strong></p>
<p>None</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakxapis.htm" title="iSeries Navigator APIs help plug-in developers obtain and manage certain types of global information.">iSeries Navigator APIs</a></div>
</div>
</div>
</body>
</html>