Function GetPropertyTenantsDataHMO
Gets a object of data about Tenants for a Tenancy
This function is a quick way to call the Function Class_HMOTenants
GetPropertyTenantsDataHMO([PROPCODE],[GETMETHOD],[GETTYPE],[SEPARATOR],[EXPRESSION])Parameters
| # | Type | Passing | Default | Name | Description/Comments |
|---|---|---|---|---|---|
| 1 | string | required | n/a | PROPCODE | The property code, usually PROPCODE. |
| 2 | integer | required | 0 | GETMETHOD | Not used - always pass 0 |
| 3 | integer | required | 0 | GETTYPE | 0/1 = Get unique email addresses (Calls GetEmailAddressList)
2 = Get unique data based on the expression in the next parameter (Calls GetExpressionList) |
| 4 | string | required | n/a | SEPARATOR | The separator character when more than one item returned. |
| 5 | string | required | n/a | EXPRESSION | The expression to use for each item (Tenant) record, when GETTYPE = 2
Expression field names must always be prefixed with CLIENT irrelevant of where this is used. e.g. CLIENT.CLCODEDESC |
| 6 | integer | optional | 0 | OPTION1 | 0 (default) = Filter to active tenancies, today falls within tenancy dates
1 = Filter to active tenancies, ignore dates |
Returns
The resulting string
Examples
Get email address for each tenant pipe ( | ) delimited.
GetPropertyTenantsDataHMO(PROPCODE,0,1,"|","")Get first name and surname for each tenant pipe ( | ) delimited.
GetPropertyTenantsDataHMO(PROPCODE,0,2,", ",",alltrim(CLIENT.FNAME)+' '+alltrim(CLIENT.SNAME)")Get mobile number for each tenant pipe with a HTML break (
) in between.
GetPropertyTenantsDataHMO(PROPCODE,0,2,"
","alltrim(CLIENT.MOBILE)")Get email address for each tenant pipe ( | ) delimited from active tenancies ignored the tenancy dates.
GetPropertyTenantsDataHMO(PROPCODE,0,1,"|","",1)
