/usr/share/gtk-doc/html/libgda-5.0/libgda-5.0-GdaLdapConnection.html is in libgda-5.0-doc 5.2.4-9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaLdapConnection: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="virtual_connection.html" title="Virtual connections">
<link rel="prev" href="GdaVconnectionHub.html" title="GdaVconnectionHub">
<link rel="next" href="data_models.html" title="Data handling">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libgda-5.0-GdaLdapConnection.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="virtual_connection.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdaVconnectionHub.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="data_models.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgda-5.0-GdaLdapConnection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-5.0-GdaLdapConnection.top_of_page"></a>GdaLdapConnection</span></h2>
<p>GdaLdapConnection — LDAP connection objects</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgda-5.0-GdaLdapConnection.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaLdapConnection.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-connection-get-base-dn" title="gda_ldap_connection_get_base_dn ()">gda_ldap_connection_get_base_dn</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-connection-declare-table" title="gda_ldap_connection_declare_table ()">gda_ldap_connection_declare_table</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-connection-undeclare-table" title="gda_ldap_connection_undeclare_table ()">gda_ldap_connection_undeclare_table</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-is-dn" title="gda_ldap_is_dn ()">gda_ldap_is_dn</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-dn-split" title="gda_ldap_dn_split ()">gda_ldap_dn_split</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="returnvalue">GdaLdapEntry</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-describe-entry" title="gda_ldap_describe_entry ()">gda_ldap_describe_entry</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-entry-free" title="gda_ldap_entry_free ()">gda_ldap_entry_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="returnvalue">GdaLdapEntry</span></a> **
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-get-entry-children" title="gda_ldap_get_entry_children ()">gda_ldap_get_entry_children</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-entry-add-attribute" title="gda_ldap_entry_add_attribute ()">gda_ldap_entry_add_attribute</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="returnvalue">GdaLdapEntry</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-entry-new" title="gda_ldap_entry_new ()">gda_ldap_entry_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-entry-get-attributes-list" title="gda_ldap_entry_get_attributes_list ()">gda_ldap_entry_get_attributes_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-attributes-list-free" title="gda_ldap_attributes_list_free ()">gda_ldap_attributes_list_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-add-entry" title="gda_ldap_add_entry ()">gda_ldap_add_entry</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-remove-entry" title="gda_ldap_remove_entry ()">gda_ldap_remove_entry</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-rename-entry" title="gda_ldap_rename_entry ()">gda_ldap_rename_entry</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-modify-entry" title="gda_ldap_modify_entry ()">gda_ldap_modify_entry</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapClass" title="GdaLdapClass"><span class="returnvalue">GdaLdapClass</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-get-class-info" title="gda_ldap_get_class_info ()">gda_ldap_get_class_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-get-top-classes" title="gda_ldap_get_top_classes ()">gda_ldap_get_top_classes</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaLdapConnection.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection">GdaLdapConnection</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnectionClass" title="struct GdaLdapConnectionClass">GdaLdapConnectionClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnectionPrivate" title="GdaLdapConnectionPrivate">GdaLdapConnectionPrivate</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapAttribute" title="GdaLdapAttribute">GdaLdapAttribute</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry">GdaLdapEntry</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapAttributeDefinition" title="GdaLdapAttributeDefinition">GdaLdapAttributeDefinition</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapModificationType" title="enum GdaLdapModificationType">GdaLdapModificationType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapClassKind" title="enum GdaLdapClassKind">GdaLdapClassKind</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapClass" title="GdaLdapClass">GdaLdapClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaLdapConnection.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <virtual/gda-ldap-connection.h>
</pre>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaLdapConnection.description"></a><h2>Description</h2>
<p>This is a connection, as opened by the LDAP provider. Use
<a class="link" href="GdaConnection.html#gda-connection-open-from-string" title="gda_connection_open_from_string ()"><code class="function">gda_connection_open_from_string()</code></a> or <a class="link" href="GdaConnection.html#gda-connection-open-from-dsn" title="gda_connection_open_from_dsn ()"><code class="function">gda_connection_open_from_dsn()</code></a> to create
a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> connection.</p>
<p>Warning: if you create a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> using <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-new"><code class="function">g_object_new()</code></a>, then the resulting
object won't be functionnal.</p>
<p>A <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> is a virtual connection which accepts any of SQLite's SQL dialect.
However, some SQL commands have been added to manipulate virtual tables mapped to
LDAP searches. These commands are:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>The CREATE LDAP TABLE: </p>
<pre class="synopsis">CREATE LDAP TABLE <table name> [BASE=<base DN>] [FILTER=<LDAP filter>] [ATTRIBUTES=<LDAP attributes>] [SCOPE=<search scope>]</pre>
<p>
</p>
<p>Each of the BASE, FILTER, ATTRIBUTES and SCOPE specifications is optional. Use this command to declare a table, for example: </p>
<pre class="programlisting">CREATE LDAP TABLE users FILTER='(cn=*doe*)' SCOPE= 'SUBTREE';</pre>
<p>.
The allowed SCOPE values are: 'BASE', 'ONELEVEL' and 'SUBTREE'.
</p>
<p>See the <a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-connection-declare-table" title="gda_ldap_connection_declare_table ()"><code class="function">gda_ldap_connection_declare_table()</code></a>
for more information about the ATTRIBUTES syntax.
</p>
</li>
<li class="listitem">
<p>The DROP LDAP TABLE: </p>
<pre class="synopsis">DROP LDAP TABLE <table name></pre>
<p>
</p>
<p>Use this command to undeclare a table, for example: </p>
<pre class="programlisting">DROP LDAP TABLE users;</pre>
<p> Note that it is also possible to use the normal command to remove a table: </p>
<pre class="programlisting">DROP TABLE users;</pre>
<p>
</p>
</li>
<li class="listitem">
<p>The ALTER LDAP TABLE: </p>
<pre class="synopsis">ALTER LDAP TABLE <table name></pre>
<p> or
</p>
<pre class="synopsis">ALTER LDAP TABLE <table name> [BASE=<base DN>] [FILTER=<LDAP filter>] [ATTRIBUTES=<LDAP attributes>] [SCOPE=<search scope>]</pre>
<p>
</p>
<p>Use this command to modify the definition of a virtual table, for example: </p>
<pre class="programlisting">ALTER LDAP TABLE users FILTER='(cn=*doe*)' SCOPE='BASE';</pre>
<p> If no argument is specified after the table name, then
the definition of the virtual table is returned instead. When altering the virtual table, only the
specified parameters are altered (ie. you don't need to repeat the parameters you don't want to
be modified)
</p>
</li>
<li class="listitem">
<p>The DESCRIBE LDAP TABLE: </p>
<pre class="synopsis">DESCRIBE LDAP TABLE <table name></pre>
<p>
</p>
<p>Use this command to get the definition of the virtual table.
</p>
</li>
</ul></div>
<p>Each "LDAP" table can then be used like any other table, but you should keep in mind that <span class="application">Libgda</span>
can optimize the LDAP search command executed when the table's data is actually read if you use
a "WHERE" clause which involves a search criteria on an LDAP attribute. For example the following
SQL: </p>
<pre class="programlisting">SELECT * FROM users WHERE cn MATCH '<code class="literal">doe</code>%';</pre>
<p> will actually
be optimized by requesting an LDAP search with the filter </p>
<pre class="programlisting">(cn=*doe*)</pre>
<p>
Optimizations can be done on MATCH, =, <, <=, > and >= operators, the LIKE operator
will not be optimized.</p>
<p>However a command like </p>
<pre class="programlisting">SELECT * FROM users WHERE cn MATCH '<code class="literal">doe</code>%' OR uid=123;</pre>
<p>
can't be optimized (because of the "OR") whereas the</p>
<pre class="programlisting">SELECT * FROM users WHERE cn MATCH '%doe%' AND uid=123;</pre>
<p>will be optimized because of the "AND".</p>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaLdapConnection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-ldap-connection-get-base-dn"></a><h3>gda_ldap_connection_get_base_dn ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gda_ldap_connection_get_base_dn (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>);</pre>
<p>Get the base DN which was used when the LDAP connection was opened</p>
<div class="refsect3">
<a name="gda-ldap-connection-get-base-dn.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-connection-get-base-dn.returns"></a><h4>Returns</h4>
<p> the base DN, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: 4.2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-connection-declare-table"></a><h3>gda_ldap_connection_declare_table ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_ldap_connection_declare_table (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *table_name</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_dn</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filter</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attributes</code></em>,
<em class="parameter"><code><a class="link" href="libgda-5.0-GdaDataModelLdap.html#GdaLdapSearchScope" title="enum GdaLdapSearchScope"><span class="type">GdaLdapSearchScope</span></a> scope</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Declare a virtual table based on an LDAP search.</p>
<p>The <em class="parameter"><code>filter</code></em>
argument, if not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, must be a valid LDAP filter string (including the opening and
closing parenthesis).</p>
<p>The <em class="parameter"><code>attribute</code></em>
, if not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, is a list of comma separated LDAP entry attribute names. For each attribute
it is also possible to specify a requested <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a>, and how to behave in case of multi valued attributes
So the general format for an attribute is:
"<attribute name>::&lt;type&gt;", where:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>"::<type>" is optional, see <a class="link" href="libgda-5.0-Utility-functions.html#gda-g-type-from-string" title="gda_g_type_from_string ()"><code class="function">gda_g_type_from_string()</code></a> for more
information about valie values for <type></p></li>
<li class="listitem">
<p>"::<muti value handler>" is also optional and specifies how a multi
values attributed is treated. The possibilities for <muti value handler> are:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
<li class="listitem"><p>"NULL" or "0": a NULL value will be returned</p></li>
<li class="listitem"><p>"CSV": a comma separated value with all the values of the attribute will be
returned. This only works for G_TYPE_STRING attribute types.</p></li>
<li class="listitem"><p>"MULT" of "*": a row will be returned for each value of the attribute, effectively
multiplying the number of returned rows</p></li>
<li class="listitem"><p>"1": only the first vakue of the attribute will be used, the other values ignored</p></li>
<li class="listitem"><p>"CONCAT": the attributes' values are concatenated (with a newline char between each value)</p></li>
<li class="listitem"><p>"ERROR": an error value will be returned (this is the default behaviour)</p></li>
</ul></div>
<p>
</p>
</li>
</ul></div>
<p> After each attribute
name (and before the comma for the next attribute if any), it is possible to specify the <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type using
the "::<type>" syntax (see <a class="link" href="libgda-5.0-Utility-functions.html#gda-g-type-from-string" title="gda_g_type_from_string ()"><code class="function">gda_g_type_from_string()</code></a> for more information). </p>
<p>The following example specifies the "uidNumber" attribute to be returned as a string, the "mail" attribute,
and the "objectClass" attribute to be handled as one row per value of that attribute:</p>
<pre class="programlisting">"uidNumber::string,mail,objectClass::*"</pre>
<div class="refsect3">
<a name="gda-ldap-connection-declare-table.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>table_name</p></td>
<td class="parameter_description"><p>a table name, not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>base_dn</p></td>
<td class="parameter_description"><p>the base DN of the LDAP search, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>cnc</code></em>
's own base DN. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>the search filter of the LDAP search, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for a default filter of "(ObjectClass=*)". </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>attributes</p></td>
<td class="parameter_description"><p>the search attributes of the LDAP search, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if only the DN is required. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>scope</p></td>
<td class="parameter_description"><p>the search scope of the LDAP search</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-connection-declare-table.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if no error occurred</p>
</div>
<p class="since">Since: 4.2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-connection-undeclare-table"></a><h3>gda_ldap_connection_undeclare_table ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_ldap_connection_undeclare_table (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *table_name</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Remove a table which has been declared using <a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-connection-declare-table" title="gda_ldap_connection_declare_table ()"><code class="function">gda_ldap_connection_declare_table()</code></a>.</p>
<div class="refsect3">
<a name="gda-ldap-connection-undeclare-table.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>table_name</p></td>
<td class="parameter_description"><p>a table name, not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-connection-undeclare-table.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if no error occurred</p>
</div>
<p class="since">Since: 4.2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-is-dn"></a><h3>gda_ldap_is_dn ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_ldap_is_dn (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dn</code></em>);</pre>
<p>Tells if <em class="parameter"><code>dn</code></em>
represents a distinguished name (it only checks for the syntax, not for
the actual existence of the entry with that distinguished name).</p>
<div class="refsect3">
<a name="gda-ldap-is-dn.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dn</p></td>
<td class="parameter_description"><p>a Distinguished Name string</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-is-dn.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>dn</code></em>
is a valid representation of a distinguished name</p>
</div>
<p class="since">Since: 4.2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-dn-split"></a><h3>gda_ldap_dn_split ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
gda_ldap_dn_split (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dn</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> all</code></em>);</pre>
<p>Splits <em class="parameter"><code>dn</code></em>
into its components.</p>
<div class="refsect3">
<a name="gda-ldap-dn-split.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dn</p></td>
<td class="parameter_description"><p>a Distinguished Name string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>all</p></td>
<td class="parameter_description"><p>set to <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to split <em class="parameter"><code>dn</code></em>
into its RND and its parent DN, or <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to completely split <em class="parameter"><code>dn</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-dn-split.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array containing the DN parts (free using <a href="../glib/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a>), or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred because <em class="parameter"><code>dn</code></em>
is not a valid DN expression. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][Free-function: g_strfreev]</span></p>
</div>
<p class="since">Since: 4.2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-describe-entry"></a><h3>gda_ldap_describe_entry ()</h3>
<pre class="programlisting"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="returnvalue">GdaLdapEntry</span></a> *
gda_ldap_describe_entry (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dn</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Describes the LDAP entry which DN is <em class="parameter"><code>dn</code></em>
. If <em class="parameter"><code>dn</code></em>
is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the top entry (as specified when
the LDAP connection was opened) is described.</p>
<div class="refsect3">
<a name="gda-ldap-describe-entry.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> connection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dn</p></td>
<td class="parameter_description"><p>the Distinguished Name of the LDAP entry to describe. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-describe-entry.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred or if the <em class="parameter"><code>dn</code></em>
entry does not exist. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][Free-function: gda_ldap_entry_free]</span></p>
</div>
<p class="since">Since: 4.2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-entry-free"></a><h3>gda_ldap_entry_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_ldap_entry_free (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a> *entry</code></em>);</pre>
<p>Frees <em class="parameter"><code>entry</code></em>
</p>
<div class="refsect3">
<a name="gda-ldap-entry-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a> pointer. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 4.2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-get-entry-children"></a><h3>gda_ldap_get_entry_children ()</h3>
<pre class="programlisting"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="returnvalue">GdaLdapEntry</span></a> **
gda_ldap_get_entry_children (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dn</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **attributes</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Get the list of children entries for the LDAP entry which DN is <em class="parameter"><code>dn</code></em>
. If the <em class="parameter"><code>dn</code></em>
entry does not have any
child, then this function returns an array which first element is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p>If <em class="parameter"><code>dn</code></em>
is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the top entry (as specified when the LDAP connection was opened) is used.</p>
<div class="refsect3">
<a name="gda-ldap-get-entry-children.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> connection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dn</p></td>
<td class="parameter_description"><p>the Distinguished Name of the LDAP entry to get children from. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>attributes</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of attributes to fetch for each child, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no attribute is requested. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> gchar*]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-get-entry-children.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a> for each child entry, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred or if the <em class="parameter"><code>dn</code></em>
entry does not exist. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][element_type GdaLdapEntry][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1]</span></p>
</div>
<p class="since">Since: 4.2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-entry-add-attribute"></a><h3>gda_ldap_entry_add_attribute ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_ldap_entry_add_attribute (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a> *entry</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> merge</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attr_name</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nb_values</code></em>,
<em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> **values</code></em>);</pre>
<p>Add an attribute (ans its values) to <em class="parameter"><code>entry</code></em>
. If the attribute is already present in <em class="parameter"><code>entry</code></em>
,
then the attribute's values are merged or replaced depending on the <em class="parameter"><code>merge</code></em>
argument.</p>
<div class="refsect3">
<a name="gda-ldap-entry-add-attribute.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a> pointer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>merge</p></td>
<td class="parameter_description"><p>set to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to merge the values in case of an existing attribute in <em class="parameter"><code>entry</code></em>
, and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to replace any existing attribute's values in <em class="parameter"><code>entry</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>attr_name</p></td>
<td class="parameter_description"><p>the name of the attribute to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>nb_values</p></td>
<td class="parameter_description"><p>number of values in <em class="parameter"><code>values</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>values</p></td>
<td class="parameter_description"><p>an array of <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> (as much values as specified by <em class="parameter"><code>nb_values</code></em>
). </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=nb_values]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 5.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-entry-new"></a><h3>gda_ldap_entry_new ()</h3>
<pre class="programlisting"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="returnvalue">GdaLdapEntry</span></a> *
gda_ldap_entry_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dn</code></em>);</pre>
<p>Creates a new <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a>. This function is useful when using <a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-modify-entry" title="gda_ldap_modify_entry ()"><code class="function">gda_ldap_modify_entry()</code></a></p>
<div class="refsect3">
<a name="gda-ldap-entry-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dn</p></td>
<td class="parameter_description"><p>a Distinguished name, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-entry-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a></p>
</div>
<p class="since">Since: 5.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-entry-get-attributes-list"></a><h3>gda_ldap_entry_get_attributes_list ()</h3>
<pre class="programlisting"><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
gda_ldap_entry_get_attributes_list (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a> *entry</code></em>);</pre>
<p>Get a list of all the possible attributes which <em class="parameter"><code>entry</code></em>
can have. Each possible attribute is represented
by a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapAttributeDefinition" title="GdaLdapAttributeDefinition"><span class="type">GdaLdapAttributeDefinition</span></a> strunture.</p>
<div class="refsect3">
<a name="gda-ldap-entry-get-attributes-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-entry-get-attributes-list.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapAttributeDefinition" title="GdaLdapAttributeDefinition"><span class="type">GdaLdapAttributeDefinition</span></a> pointers, free the list using <a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-attributes-list-free" title="gda_ldap_attributes_list_free ()"><code class="function">gda_ldap_attributes_list_free()</code></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> GdaLdapAttributeDefinition]</span></p>
</div>
<p class="since">Since: 5.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-attributes-list-free"></a><h3>gda_ldap_attributes_list_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_ldap_attributes_list_free (<em class="parameter"><code><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>);</pre>
<p>Frees the list returned by <a class="link" href="libgda-5.0-GdaLdapConnection.html#gda-ldap-entry-get-attributes-list" title="gda_ldap_entry_get_attributes_list ()"><code class="function">gda_ldap_entry_get_attributes_list()</code></a>.</p>
<div class="refsect3">
<a name="gda-ldap-attributes-list-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>list</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapAttributeDefinition" title="GdaLdapAttributeDefinition"><span class="type">GdaLdapAttributeDefinition</span></a> pointers, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 5.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-add-entry"></a><h3>gda_ldap_add_entry ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_ldap_add_entry (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a> *entry</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates a new LDAP entry.</p>
<div class="refsect3">
<a name="gda-ldap-add-entry.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">GdaLDapEntry</span> describing the LDAP entry to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store an error, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-add-entry.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if no error occurred</p>
</div>
<p class="since">Since: 5.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-remove-entry"></a><h3>gda_ldap_remove_entry ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_ldap_remove_entry (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dn</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Delete an LDAP entry.</p>
<div class="refsect3">
<a name="gda-ldap-remove-entry.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">GdaLDapEntry</span> describing the LDAP entry to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store an error, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-remove-entry.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if no error occurred</p>
</div>
<p class="since">Since: 5.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-rename-entry"></a><h3>gda_ldap_rename_entry ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_ldap_rename_entry (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *current_dn</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *new_dn</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Renames an LDAP entry.</p>
<div class="refsect3">
<a name="gda-ldap-rename-entry.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>current_dn</p></td>
<td class="parameter_description"><p>the current DN of the entry</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_dn</p></td>
<td class="parameter_description"><p>the new DN of the entry</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store an error, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-rename-entry.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if no error occurred</p>
</div>
<p class="since">Since: 5.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-modify-entry"></a><h3>gda_ldap_modify_entry ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_ldap_modify_entry (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapModificationType" title="enum GdaLdapModificationType"><span class="type">GdaLdapModificationType</span></a> modtype</code></em>,
<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a> *entry</code></em>,
<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapEntry" title="GdaLdapEntry"><span class="type">GdaLdapEntry</span></a> *ref_entry</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Modifies an LDAP entry.</p>
<div class="refsect3">
<a name="gda-ldap-modify-entry.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modtype</p></td>
<td class="parameter_description"><p>the type of modification to perform</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">GdaLDapEntry</span> describing the LDAP entry to apply modifications, along with the attributes which will be modified</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ref_entry</p></td>
<td class="parameter_description"><p>a <span class="type">GdaLDapEntry</span> describing the reference LDAP entry, if <em class="parameter"><code>modtype</code></em>
is <a class="link" href="libgda-5.0-GdaLdapConnection.html#GDA-LDAP-MODIFICATION-ATTR-DIFF:CAPS"><code class="literal">GDA_LDAP_MODIFICATION_ATTR_DIFF</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store an error, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-modify-entry.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if no error occurred</p>
</div>
<p class="since">Since: 5.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-get-class-info"></a><h3>gda_ldap_get_class_info ()</h3>
<pre class="programlisting"><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapClass" title="GdaLdapClass"><span class="returnvalue">GdaLdapClass</span></a> *
gda_ldap_get_class_info (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *classname</code></em>);</pre>
<p>Get information about an LDAP class</p>
<div class="refsect3">
<a name="gda-ldap-get-class-info.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>classname</p></td>
<td class="parameter_description"><p>an LDAP class name</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-get-class-info.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapClass" title="GdaLdapClass"><span class="type">GdaLdapClass</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
<p class="since">Since: 4.2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-ldap-get-top-classes"></a><h3>gda_ldap_get_top_classes ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
gda_ldap_get_top_classes (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a> *cnc</code></em>);</pre>
<p>get a list of the top level LDAP classes (ie. classes which don't have any parent)</p>
<div class="refsect3">
<a name="gda-ldap-get-top-classes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapConnection" title="struct GdaLdapConnection"><span class="type">GdaLdapConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-ldap-get-top-classes.returns"></a><h4>Returns</h4>
<p>a list of <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapClass" title="GdaLdapClass"><span class="type">GdaLdapClass</span></a> pointers (don't modify it). </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> GdaLdapClass]</span></p>
</div>
<p class="since">Since: 4.2.8</p>
</div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaLdapConnection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaLdapConnection"></a><h3>struct GdaLdapConnection</h3>
<pre class="programlisting">struct GdaLdapConnection {
GdaVconnectionDataModel parent;
GdaLdapConnectionPrivate *priv;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaLdapConnectionClass"></a><h3>struct GdaLdapConnectionClass</h3>
<pre class="programlisting">struct GdaLdapConnectionClass {
GdaVconnectionDataModelClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaLdapConnectionPrivate"></a><h3>GdaLdapConnectionPrivate</h3>
<pre class="programlisting">typedef struct _GdaLdapConnectionPrivate GdaLdapConnectionPrivate;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaLdapAttribute"></a><h3>GdaLdapAttribute</h3>
<pre class="programlisting">typedef struct {
gchar *attr_name;
guint nb_values;
GValue **values;
} GdaLdapAttribute;
</pre>
<p>This structure holds information about the values of a single attribute (of a single LDAP entry).</p>
<div class="refsect3">
<a name="GdaLdapAttribute.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaLdapAttribute.attr-name"></a>attr_name</code></em>;</p></td>
<td class="struct_member_description"><p>the name of the attribute</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GdaLdapAttribute.nb-values"></a>nb_values</code></em>;</p></td>
<td class="struct_member_description"><p>the number of values in <em class="parameter"><code>values</code></em>
, or <code class="literal">0</code></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> **<em class="structfield"><code><a name="GdaLdapAttribute.values"></a>values</code></em>;</p></td>
<td class="struct_member_description"><p>the attribute' values as <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> values, (terminated by a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>). </p></td>
<td class="struct_member_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=nb_values][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GdaLdapEntry"></a><h3>GdaLdapEntry</h3>
<pre class="programlisting">typedef struct {
gchar *dn;
guint nb_attributes;
GdaLdapAttribute **attributes;
GHashTable *attributes_hash;
} GdaLdapEntry;
</pre>
<p>This structure holds information about the attributes of a single LDAP entry.</p>
<div class="refsect3">
<a name="GdaLdapEntry.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaLdapEntry.dn"></a>dn</code></em>;</p></td>
<td class="struct_member_description"><p>the Distinguished Name of the entry</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GdaLdapEntry.nb-attributes"></a>nb_attributes</code></em>;</p></td>
<td class="struct_member_description"><p>the number of attributes in <em class="parameter"><code>attributes</code></em>
, or <code class="literal">0</code></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapAttribute" title="GdaLdapAttribute"><span class="type">GdaLdapAttribute</span></a> **<em class="structfield"><code><a name="GdaLdapEntry.attributes"></a>attributes</code></em>;</p></td>
<td class="struct_member_description"><p>the entry's attributes, (terminated by a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>). </p></td>
<td class="struct_member_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=nb_attributes][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1]</span></td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *<em class="structfield"><code><a name="GdaLdapEntry.attributes-hash"></a>attributes_hash</code></em>;</p></td>
<td class="struct_member_description"><p>a hash table where the key is an attribute name, and the value the correcponding <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapAttribute" title="GdaLdapAttribute"><span class="type">GdaLdapAttribute</span></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GdaLdapAttributeDefinition"></a><h3>GdaLdapAttributeDefinition</h3>
<pre class="programlisting">typedef struct {
gchar *name;
GType g_type;
gboolean required;
} GdaLdapAttributeDefinition;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaLdapModificationType"></a><h3>enum GdaLdapModificationType</h3>
<p>Speficies the type of operation requested when writing to an LDAP directory.</p>
<div class="refsect3">
<a name="GdaLdapModificationType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-MODIFICATION-INSERT:CAPS"></a>GDA_LDAP_MODIFICATION_INSERT</p></td>
<td class="enum_member_description">
<p>modification corresponds to a new LDAP entry</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-MODIFICATION-DELETE:CAPS"></a>GDA_LDAP_MODIFICATION_DELETE</p></td>
<td class="enum_member_description">
<p>modification corresponds to removing an LDAP entry</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-MODIFICATION-ATTR-ADD:CAPS"></a>GDA_LDAP_MODIFICATION_ATTR_ADD</p></td>
<td class="enum_member_description">
<p>modification correspond to adding attributes to an existing LDAP entry</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-MODIFICATION-ATTR-DEL:CAPS"></a>GDA_LDAP_MODIFICATION_ATTR_DEL</p></td>
<td class="enum_member_description">
<p>modification correspond to removing attributes from an existing LDAP entry</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-MODIFICATION-ATTR-REPL:CAPS"></a>GDA_LDAP_MODIFICATION_ATTR_REPL</p></td>
<td class="enum_member_description">
<p>modification correspond to replacing attributes of an existing LDAP entry</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-MODIFICATION-ATTR-DIFF:CAPS"></a>GDA_LDAP_MODIFICATION_ATTR_DIFF</p></td>
<td class="enum_member_description">
<p>modification correspond to modifying attributes to an existing LDAP entry</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GdaLdapClassKind"></a><h3>enum GdaLdapClassKind</h3>
<p>Defines the LDAP class type</p>
<div class="refsect3">
<a name="GdaLdapClassKind.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-CLASS-KIND-ABSTRACT:CAPS"></a>GDA_LDAP_CLASS_KIND_ABSTRACT</p></td>
<td class="enum_member_description">
<p>the LDAP class is an abstract class</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-CLASS-KIND-STRUTURAL:CAPS"></a>GDA_LDAP_CLASS_KIND_STRUTURAL</p></td>
<td class="enum_member_description">
<p>the LDAP class is a structural class</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-CLASS-KIND-AUXILIARY:CAPS"></a>GDA_LDAP_CLASS_KIND_AUXILIARY</p></td>
<td class="enum_member_description">
<p>the LDAP class is auxilliary</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-LDAP-CLASS-KIND-UNKNOWN:CAPS"></a>GDA_LDAP_CLASS_KIND_UNKNOWN</p></td>
<td class="enum_member_description">
<p>the LDAP class type is not known</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GdaLdapClass"></a><h3>GdaLdapClass</h3>
<pre class="programlisting">typedef struct {
gchar *oid;
guint nb_names; /* always >= 1 */
gchar **names;
gchar *description;
GdaLdapClassKind kind;
gboolean obsolete;
guint nb_req_attributes;
gchar **req_attributes;
guint nb_opt_attributes;
gchar **opt_attributes;
GSList *parents; /* list of #GdaLdapClass */
GSList *children; /* list of #GdaLdapClass */
} GdaLdapClass;
</pre>
<p>Represents an LDAP declared class.</p>
<div class="refsect3">
<a name="GdaLdapClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaLdapClass.oid"></a>oid</code></em>;</p></td>
<td class="struct_member_description"><p>the OID of the class</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GdaLdapClass.nb-names"></a>nb_names</code></em>;</p></td>
<td class="struct_member_description"><p>the number of values in <em class="parameter"><code>values</code></em>
(always >= 1)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **<em class="structfield"><code><a name="GdaLdapClass.names"></a>names</code></em>;</p></td>
<td class="struct_member_description"><p>all the class names</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdaLdapClass.description"></a>description</code></em>;</p></td>
<td class="struct_member_description"><p>the class's description, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="struct_member_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapClassKind" title="enum GdaLdapClassKind"><span class="type">GdaLdapClassKind</span></a> <em class="structfield"><code><a name="GdaLdapClass.kind"></a>kind</code></em>;</p></td>
<td class="struct_member_description"><p>the class kind</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GdaLdapClass.obsolete"></a>obsolete</code></em>;</p></td>
<td class="struct_member_description"><p>defines is LDAP class is obsolete</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GdaLdapClass.nb-req-attributes"></a>nb_req_attributes</code></em>;</p></td>
<td class="struct_member_description"><p>the number of values in <em class="parameter"><code>req_attributes</code></em>
</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **<em class="structfield"><code><a name="GdaLdapClass.req-attributes"></a>req_attributes</code></em>;</p></td>
<td class="struct_member_description"><p>names of required attributes in class</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GdaLdapClass.nb-opt-attributes"></a>nb_opt_attributes</code></em>;</p></td>
<td class="struct_member_description"><p>the number of values in <em class="parameter"><code>opt_attributes</code></em>
</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **<em class="structfield"><code><a name="GdaLdapClass.opt-attributes"></a>opt_attributes</code></em>;</p></td>
<td class="struct_member_description"><p>names of optional attributes in class</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *<em class="structfield"><code><a name="GdaLdapClass.parents"></a>parents</code></em>;</p></td>
<td class="struct_member_description"><p><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of the parent classes (pointers to <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapClass" title="GdaLdapClass"><span class="type">GdaLdapClass</span></a>)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *<em class="structfield"><code><a name="GdaLdapClass.children"></a>children</code></em>;</p></td>
<td class="struct_member_description"><p><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of the children classes (pointers to <a class="link" href="libgda-5.0-GdaLdapConnection.html#GdaLdapClass" title="GdaLdapClass"><span class="type">GdaLdapClass</span></a>)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|