-
Notifications
You must be signed in to change notification settings - Fork 61
Expand file tree
/
Copy pathldap-exop-sync.xml
More file actions
132 lines (127 loc) · 4.79 KB
/
Copy pathldap-exop-sync.xml
File metadata and controls
132 lines (127 loc) · 4.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 9faf0215daa7a2b5d84525d7d2b3d6b066cc85ec Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.ldap-exop-sync" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ldap_exop_sync</refname>
<refpurpose>Efectúa una operación extendida</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>LDAP\Result</type><type>bool</type></type><methodname>ldap_exop_sync</methodname>
<methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
<methodparam><type>string</type><parameter>request_oid</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>request_data</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">response_data</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">response_oid</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Efectúa una operación extendida en el <parameter>ldap</parameter> especificado con
<parameter>request_oid</parameter> el <acronym>OID</acronym> de la operación y
<parameter>request_data</parameter> los datos.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>ldap</parameter></term>
<listitem>
<simpara>
&ldap.parameter.ldap;
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>request_oid</parameter></term>
<listitem>
<simpara>
El <acronym>OID</acronym> de la petición de operación extendida.
Puede ser una de las constantes
<constant>LDAP_EXOP_<replaceable>*</replaceable></constant>,
o una cadena con el <acronym>OID</acronym> de la operación.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>request_data</parameter></term>
<listitem>
<simpara>
Los datos de la petición de operación extendida.
Puede ser &null; para algunas operaciones como <constant>LDAP_EXOP_WHO_AM_I</constant>,
y también puede necesitar estar codificado en <acronym>BER</acronym>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>controls</parameter></term>
<listitem>
<simpara>
Un array de <link linkend="ldap.controls">controles LDAP</link> a enviar con la solicitud.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>response_data</parameter></term>
<listitem>
<simpara>
Será rellenado con los datos de respuesta de la operación extendida si se proporcionan.
Si no se proporcionan, puede utilizarse <function>ldap_parse_exop</function> en el objeto
resultado posteriormente para obtener estos datos.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>response_oid</parameter></term>
<listitem>
<simpara>
Será rellenado con el <acronym>OID</acronym> de respuesta si se proporciona,
generalmente igual al <acronym>OID</acronym> de la solicitud.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Al utilizarse con <parameter>response_data</parameter>,
devuelve &true; en caso de éxito o &false; en caso de error.
Al utilizarse sin <parameter>response_data</parameter>,
devuelve un identificador de resultado o &false; en caso de error.
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ldap_exop</function></member>
<member><function>ldap_exop_whoami</function></member>
<member><function>ldap_exop_refresh</function></member>
<member><function>ldap_exop_passwd</function></member>
<member><function>ldap_parse_result</function></member>
<member><function>ldap_parse_exop</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->