| Parameter
|
Description
|
Possible Values
|
Default Value
|
Example
|
| tpl
|
Template used to display output
|
Any valid template
|
The template, function_list_linkcodes
|
tpl="mytemplate"
|
| code_only
|
Displays the linkcode as either a complete or relative URL
|
0 or 1 (exclusive)
|
0: displays entire URL
|
code_only="1"
|
| campaigns
|
Return only linkcodes available to a list of campaigns. If set, ignores campaign and use_default_campaign below
|
An array reference (see Notes section below)
|
None.
|
campaigns="$my_array"
|
| campaign
|
Return only linkcodes available to a single campaign. If set, ignores use_default_campaign below
|
Any valid campaign number
|
The user's current default campaign
|
campaign="123"
|
| use_default_campaign
|
Return only linkcodes available to the database's stored default campaign for the current user. (See notes for arguments, campaign and campaigns, above)
|
0 or 1 (exclusive)
|
None.
|
use_default_campaign="1"
|
| userid
|
The user ID number to get the default campaign from
|
Any valid user ID number
|
The currently logged in user.
|
userid="123"
|
| programs
|
Return only linkcodes available to a list of programs If set, ignores program below
|
An array reference (see Notes section below)
|
None.
|
programs="$my_array"
|
| program
|
Returns only linkcodes available to a single program. If set, ignores use_default_program below
|
Any valid program ID number
|
The user's default program
|
program="123"
|
| use_default_program
|
Returns only linkcodes available to the database's stored default program for the current user. (See notes for arguments, program and programs, above)
|
0 or 1 (exclusive)
|
None. The default in program will apply (see program above)
|
use_default_campaign="1"
|
| sites
|
Return only linkcodes available to a list of sites. If set, ignores site and use_default_site below
|
An array reference (see Notes section below)
|
None.
|
sites="$my_array"
|
| site
|
Return only linkcodes available to a particular site. If set, ignores use_default_site below
|
Any valid site ID number
|
The user's default site
|
site="123"
|
| use_default_site
|
Returns only linkcodes available to the database's stored default site for current user. (See notes for arguments site and sites, above)
|
0 or 1 (exclusive)
|
None. The default site will apply (see site above)
|
use_default_site="1"
|
| tour
|
Return only linkcodes available to a particular tour. (See note in tours below)
|
Any valid tour ID number
|
All tours unless tours, below, is used
|
tour="123"
|
| tours
|
Return only linkcodes available to a list of tours. If set, overwrites tour above
|
An array reference (see Notes section below)
|
All tours unless tour, above, is used
|
tours="$my_array"
|
| adtool
|
Return only linkcodes available to a particular adtool. (See note in adtools below)
|
Any valid adtool ID number
|
All adtools unless adtools, below, is used
|
adtool="123"
|
| adtools
|
Return only linkcodes available to a list of adtools. If set, overwrites adtool above
|
An array reference (see Notes section below)
|
All adtools unless adtool, above, is used
|
adtools="$my_array"
|
| subid1
|
Return only linkcodes available to a particular first subid (See note in subids1 below)
|
Any valid first sub ID number
|
All first subids unless subids1, below, is used
|
subid1="123"
|
| subids1
|
Return only linkcodes available to a list of first subids If set, overwrites subid1 above
|
An array reference (see Notes section below)
|
All subids unless subid1, above, is used
|
subids1="$my_array"
|
| subid2
|
Return only linkcodes available to a particular second subid. (See note in subids2 below)
|
Any valid second sub ID number
|
All second subids unless subid2, below, is used
|
subid2="123"
|
| subids2
|
Return only linkcodes available to a list of second subids. If set, overwrites subid2 above
|
An array reference (see Notes section below)
|
All second subids unless subid2, above, is used
|
subids2="$my_array"
|
| count
|
Max number of linkcodes to display
|
Any whole number greater than zero
|
None. Displays all matching linkcodes
|
count="10"
|
| assign_prefix
|
Prefix output variables with this word. (Click link for details)
|
Any valid Smarty variable name
|
None. (No prefix is used)
|
assign_prefix="myvar"
|
| data_only
|
Set variables but don't display the template
|
1
|
None. The template is displayed.
|
data_only=1
|
| show_hidden
|
Show link codes for hidden sites.
|
0 or 1 (exclusive)
|
None. Do not show hidden sites
|
show_hidden="1"
|
| order
|
Change the ordering of the link codes returned by the template function
|
(see Notes section below)
|
s.name, t.name
|
order="s.name, t.name"
|
