{
    "content": [
        {
            "type": "text",
            "text": "# Net::LDAP::Control::Sort (perldoc)\n\n## NAME\n\nNet::LDAP::Control::Sort - Server Side Sort (SSS) control object\n\n## SYNOPSIS\n\nuse Net::LDAP::Control::Sort;\nuse Net::LDAP::Constant qw(LDAPCONTROLSORTRESULT);\n$sort = Net::LDAP::Control::Sort->new(\norder => \"cn -phone\"\n);\n$mesg = $ldap->search( @args, control => [ $sort ]);\n($resp) = $mesg->control( LDAPCONTROLSORTRESULT );\nprint \"Results are sorted\\n\"  if $resp and !$resp->result;\n\n## DESCRIPTION\n\n\"Net::LDAP::Control::Sort\" is a sub-class of Net::LDAP::Control. It provides a class for\nmanipulating the LDAP Server Side Sort (SSS) request control 1.2.840.113556.1.4.473 as defined\nin RFC-2891\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **CONSTRUCTOR ARGUMENTS**\n- **METHODS**\n- **SEE ALSO**\n- **AUTHOR**\n- **COPYRIGHT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Net::LDAP::Control::Sort",
        "section": "",
        "mode": "perldoc",
        "summary": "Net::LDAP::Control::Sort - Server Side Sort (SSS) control object",
        "synopsis": "use Net::LDAP::Control::Sort;\nuse Net::LDAP::Constant qw(LDAPCONTROLSORTRESULT);\n$sort = Net::LDAP::Control::Sort->new(\norder => \"cn -phone\"\n);\n$mesg = $ldap->search( @args, control => [ $sort ]);\n($resp) = $mesg->control( LDAPCONTROLSORTRESULT );\nprint \"Results are sorted\\n\"  if $resp and !$resp->result;",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 13,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 7,
                "subsections": []
            },
            {
                "name": "CONSTRUCTOR ARGUMENTS",
                "lines": 23,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 3,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Net::LDAP::Control::Sort - Server Side Sort (SSS) control object\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use Net::LDAP::Control::Sort;\nuse Net::LDAP::Constant qw(LDAPCONTROLSORTRESULT);\n\n$sort = Net::LDAP::Control::Sort->new(\norder => \"cn -phone\"\n);\n\n$mesg = $ldap->search( @args, control => [ $sort ]);\n\n($resp) = $mesg->control( LDAPCONTROLSORTRESULT );\n\nprint \"Results are sorted\\n\"  if $resp and !$resp->result;\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "\"Net::LDAP::Control::Sort\" is a sub-class of Net::LDAP::Control. It provides a class for\nmanipulating the LDAP Server Side Sort (SSS) request control 1.2.840.113556.1.4.473 as defined\nin RFC-2891\n\nIf the server supports sorting, then the response from a search operation will include a sort\nresult control. This control is handled by Net::LDAP::Control::SortResult.\n",
                "subsections": []
            },
            "CONSTRUCTOR ARGUMENTS": {
                "content": "order\nA string which defines how entries may be sorted. It consists of multiple directives,\nseparated by whitespace. Each directive describes how to sort entries using a single\nattribute. If two entries have identical attributes, then the next directive in the list is\nused.\n\nEach directive specifies a sorting order as follows\n\n-attributeType:orderingRule\n\nThe leading \"-\" is optional, and if present indicates that the sorting order should be\nreversed. \"attributeType\" is the attribute name to sort by. \"orderingRule\" is optional and\nindicates the rule to use for the sort and should be valid for the given \"attributeType\".\n\nAny one attributeType should only appear once in the sorting list.\n\nExamples\n\n\"cn\"         sort by cn using the default ordering rule for the cn attribute\n\"-cn\"        sort by cn using the reverse of the default ordering rule\n\"age cn\"     sort by age first, then by cn using the default ordering rules\n\"cn:1.2.3.4\" sort by cn using the ordering rule defined as 1.2.3.4\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::SortResult, Net::LDAP::Control,\nhttp://www.ietf.org/rfc/rfc2891.txt\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Graham Barr <gbarr@pobox.com>\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) 1999-2004 Graham Barr. 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": []
            }
        }
    }
}