228 lines
6.0 KiB
HTML
228 lines
6.0 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_msgid()--Retrieve the Message ID Associated with an LDAP
|
||
|
|
Message</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_msgid()--Retrieve the Message ID Associated with an LDAP Message</h2>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
#include <ldap.h>
|
||
|
|
|
||
|
|
|
||
|
|
int ldap_msgid(
|
||
|
|
LDAPMessage <em>*msg</em>)
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Library Name/Service Program: QSYS/QGLDCLNT<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>ldap_msgid()</strong> routine returns the message ID associated
|
||
|
|
with an LDAP message. Use <strong>ldap_msgid()</strong> to match the result(s)
|
||
|
|
of an asynchronous operation with the original operation.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<p>No i5/OS authority is required.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>msg</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies a pointer to a result, as returned from <a href=
|
||
|
|
"ldap_first_msg.htm">ldap_first_message()</a>, <a href="ldap_next_msg.htm">
|
||
|
|
ldap_next_message</a>, <a href="ldap_first_entry.htm">ldap_first_entry()</a>,
|
||
|
|
<a href="ldap_next_entry.htm">ldap_next_entry()</a>, <a href=
|
||
|
|
"ldap_first_ref.htm">ldap_first_reference()</a>, or <a href=
|
||
|
|
"ldap_next_ref.htm">ldap_next_reference()</a>.<br>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Message ID</strong></dt>
|
||
|
|
|
||
|
|
<dd>if the call was successful.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>ZERO</strong></dt>
|
||
|
|
|
||
|
|
<dd>if the input pointer to LDAPMessage structure is NULL.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Conditions</h3>
|
||
|
|
|
||
|
|
<p><strong>ldap_msgid()</strong> returns ZERO if the input pointer to
|
||
|
|
LDAPMessage structure is NULL.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<p>The following message may be sent from this function.</p>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="3">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF3CF2 E</td>
|
||
|
|
<td width="85%" valign="top">Error(s) occurred during running of ldap_msgid
|
||
|
|
API.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="ldap_add.htm">ldap_add()</a> -- Perform an LDAP add
|
||
|
|
operation.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_add_ext.htm">ldap_add_ext()</a> -- Perform an LDAP add
|
||
|
|
operation with controls.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_bind.htm">ldap_bind()</a> -- Perform an LDAP bind
|
||
|
|
request.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_compare.htm">ldap_compare()</a> -- Perform an LDAP compare
|
||
|
|
operation.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_cmp_ext.htm">ldap_compare_ext()</a> -- Perform an LDAP
|
||
|
|
compare operation with controls.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_delete.htm">ldap_delete()</a> -- Perform an LDAP delete
|
||
|
|
operation.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_delete_ext.htm">ldap_delete_ext()</a> -- Perform an LDAP
|
||
|
|
delete operation with controls.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_extended_operation.htm">ldap_extended_operation()</a> --
|
||
|
|
Perform extended operations.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_first_entry.htm">ldap_first_entry()</a> -- Retrieve first
|
||
|
|
LDAP entry.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_first_msg.htm">ldap_first_message()</a> -- Retrieve First
|
||
|
|
LDAP message.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_first_ref.htm">ldap_first_reference()</a> -- Return first
|
||
|
|
continuation reference in a chain of search results.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_modify.htm">ldap_modify()</a> -- Perform an LDAP modify entry
|
||
|
|
request.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_modify_ext.htm">ldap_modify_ext()</a> -- Perform an LDAP
|
||
|
|
modify entry request with controls.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_modrdn.htm">ldap_modrdn()</a> -- Perform an LDAP modify RDN
|
||
|
|
request.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_msgtype.htm">ldap_msgtype()</a> -- Returns the type of an
|
||
|
|
LDAP message.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_next_entry.htm">ldap_next_entry()</a> -- Retrieve next LDAP
|
||
|
|
entry.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_next_msg.htm">ldap_next_message()</a> -- Retrieve Next LDAP
|
||
|
|
message.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_next_ref.htm">ldap_next_reference()</a> -- Retrieve next
|
||
|
|
continuation reference in a chain of search results.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_rename.htm">ldap_rename()</a> -- Asynchronously rename an
|
||
|
|
entry.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_result.htm">ldap_result()</a> -- Wait for result from an
|
||
|
|
asynchronous operation.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_sasl_bind.htm">ldap_sasl_bind()</a> -- Perform an LDAP SASL
|
||
|
|
bind request.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_search.htm">ldap_search()</a> -- Perform an LDAP search
|
||
|
|
operation.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_search_ext.htm">ldap_search_ext()</a> -- Asynchronously
|
||
|
|
search the directory using controls.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_simple_bind.htm">ldap_simple_bind()</a> -- Perform a simple
|
||
|
|
LDAP bind request.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V4R5
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|