ARSperl Manual - ars_GetListContainer

##

    ars_GetListContainer(
             ctrl, changedSince=0, attributes=0,      # standard
             [ ownerObjList ],                        # OPTIONAL
             containerType1,containerType2,...)       # OPTIONAL

Retrieves a list of containers on the specified server. You can retrieve all (accessible) containers or limit the list to containers of a particular type or containers modified after a specified time.

See also: GetListContainer Hash Values.

`[ ownerObjList ]`
  is an optional array reference; the list is a list of HASH references. These hash references must contain a type and an ownerName parameter. The type must be "none", "all" or "schema". If type is "schema", the ownerName contains the name of the owning schema; otherwise the ownerName should be an empty string (see example below).
attributes
  Specify &ARS::AR_HIDDEN_INCREMENT for this parameter to retrieve both visible and hidden containers. Specify NULL for this parameter to retrieve only visible containers.
containerTypes
  Specify a list of values indicating the container types to retrieve. Values are:

  Value | Meaning
  0 | Retrieve all container types (ARCON_ALL).
  1 | Retrieve all guide containers (ARCON_GUIDE).
  2 | Retrieve all application containers (ARCON_APP).
  3 | Retrieve all packing list containers (ARCON_PACK).
  4 | Retrieve all filter guide containers (ARCON_FILTER_GUIDE).
  5 | Retrieve all web service containers (ARCON_WEBSERVICE).

On success
  Returns an array of HASH references.
On failure
  Returns undef.

Example 1 (retrieve all active link guides):

    	@list = ars_GetListContainer($ctrl, 0, &ARS::AR_HIDDEN_INCREMENT, &ARS::ARCON_GUIDE);
    	die "$ars_errstr" if $ars_errstr;

Example 2 (retrieve all globally owned containers plus all containers of a specific schema):

    	@list = ars_GetListContainer($ctrl, 0, &ARS::AR_HIDDEN_INCREMENT, [
    			{type => 'all',    ownerName => ''},
    			{type => 'schema', ownerName => 'Sample:Schema'},
    		] );
    	die "$ars_errstr" if $ars_errstr;

Table of Contents