157 lines
4.1 KiB
HTML
157 lines
4.1 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">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>ldap_free_urldesc()--Free an LDAP URL Description</title>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- 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. -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
|
<!-- File Edited March 2001 -->
|
|
<!-- This file has undergone html cleanup on 2/19/02 by JET -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<!-- Java sync-link -->
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<a name="Top_Of_Page"></a>
|
|
|
|
<h2>ldap_free_urldesc()--Free an LDAP URL Description</h2>
|
|
|
|
<div class="box" style="width: 90%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <ldap.h>
|
|
|
|
typedef struct ldap_url_desc {
|
|
char *lud_host; /* LDAP host to contact */
|
|
int lud_port; /* port on host */
|
|
char *lud_dn; /* base for search */
|
|
char **lud_attrs; /* NULL-terminate list of attributes */
|
|
int lud_scope; /* a valid LDAP_SCOPE_... value */
|
|
char *lud_filter; /* LDAP search filter */
|
|
char *lud_string; /* for internal use only */
|
|
} LDAPURLDesc;
|
|
|
|
void ldap_free_urldesc(
|
|
LDAPURLDesc *<em>ludp</em>)
|
|
</pre>
|
|
|
|
<br>
|
|
Library Name/Service Program: QSYS/QGLDCLNT<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>ldap_free_urldesc()</strong> function is called to
|
|
free an LDAP URL description that was obtained from a call to the
|
|
<a href="ldap_url_parse.htm">ldap_url_parse()</a> function.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>No i5/OS authority is required.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
|
|
<dl>
|
|
<dt><strong><em>ludp</em></strong></dt>
|
|
|
|
<dd>(Input) Points to the LDAP URL description, as returned by
|
|
<a href="ldap_url_parse.htm">ldap_url_parse()</a>.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>The <strong>ldap_free_urldesc()</strong> API does not return an error
|
|
code.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<p>The following message may be sent from this function.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td align="left" valign="top">Error(s) occurred during running of
|
|
ldap_free_urldesc API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li><a href="ldap_is_ldap_url.htm">ldap_is_ldap_url()</a> -- Check a URL string
|
|
to see if it is an LDAP URL.</li>
|
|
|
|
<li><a href="ldap_url_parse.htm">ldap_url_parse()</a> -- Break up an LDAP URL
|
|
string into its components.</li>
|
|
|
|
<li><a href="ldap_url_search.htm">ldap_url_search()</a> -- Asynchronously
|
|
search using an LDAP URL.</li>
|
|
|
|
<li><a href="ldap_url_search_s.htm">ldap_url_search_s()</a> -- Synchronously
|
|
search using an LDAP URL.</li>
|
|
|
|
<li><a href="ldap_url_search_st.htm">ldap_url_search_st()</a> -- Synchronously
|
|
search using an LDAP URL and a timeout.</li>
|
|
</ul>
|
|
|
|
<hr>
|
|
API introduced: V4R3
|
|
|
|
<hr>
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"dirserv1.htm">LDAP APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|