{
    "mode": "perldoc",
    "parameter": "Net::LDAP::Control::Subentries",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Net%3A%3ALDAP%3A%3AControl%3A%3ASubentries/json",
    "generated": "2026-07-05T09:34:06Z",
    "synopsis": "use Net::LDAP;\nuse Net::LDAP::Control::Subentries;\n$ldap = Net::LDAP->new( \"ldap.mydomain.eg\" );\n$subentries = Net::LDAP::Control::Subentries->new( visibility => 1 );\n$msg = $ldap->search( base => 'dc=sub,dc=mydomain,dc=eg\",\nfilter => '(objectclass=*)',\nattrs => [ qw/1.1/ ],\ncontrol => [ $subentries ] );\ndie \"error: \",$msg->code(),\": \",$msg->error()  if ($msg->code());",
    "sections": {
        "NAME": {
            "content": "Net::LDAP::Control::Subentries - LDAPv3 Subentries control object\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "use Net::LDAP;\nuse Net::LDAP::Control::Subentries;\n\n$ldap = Net::LDAP->new( \"ldap.mydomain.eg\" );\n\n$subentries = Net::LDAP::Control::Subentries->new( visibility => 1 );\n\n$msg = $ldap->search( base => 'dc=sub,dc=mydomain,dc=eg\",\nfilter => '(objectclass=*)',\nattrs => [ qw/1.1/ ],\ncontrol => [ $subentries ] );\n\ndie \"error: \",$msg->code(),\": \",$msg->error()  if ($msg->code());\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "\"Net::LDAP::Control::Subentries\" provides an interface for the creation and manipulation of\nobjects that represent the \"Subentries\" control as described by RFC 3672.\n\nThis control, for which no corresponding response control exists, is appropriate for LDAP search\noperations only.\n\nIn absence of this control, subentries are visible only to LDAP search requests with \"scope =>\n'base'\", but not to searches with any other \"scope\" value.\n",
            "subsections": []
        },
        "CONSTRUCTOR ARGUMENTS": {
            "content": "In addition to the constructor arguments described in Net::LDAP::Control the following are\nprovided:\n\nvisibility\nA Boolean value indicating the visibility of subentries or regular entries.\n\nThe value \"TRUE\" indicates that subentries are visible and normal entries are not; the value\n\"FALSE\" indicates that normal entries are visible and subentries are not.\n",
            "subsections": []
        },
        "METHODS": {
            "content": "As with Net::LDAP::Control each constructor argument described above is also available as a\nmethod on the object which will return the current value for the attribute if called without an\nargument, and set a new value for the attribute if called with an argument.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "Net::LDAP, Net::LDAP::Control,\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Peter Marschall <peter@adpm.de>.\n\nPlease report any bugs, or post any suggestions, to the perl-ldap mailing list\n<perl-ldap@perl.org>\n",
            "subsections": []
        },
        "COPYRIGHT": {
            "content": "Copyright (c) 2020 Peter Marschall. All rights reserved. This program is free software; you can\nredistribute it and/or modify it under the same terms as Perl itself.\n",
            "subsections": []
        }
    },
    "summary": "Net::LDAP::Control::Subentries - LDAPv3 Subentries control object",
    "flags": [],
    "examples": [],
    "see_also": []
}