' ****************************************************************************
' Function: TEMPLATE
'
' Standard template for PSM JavaScript macros.
'
' Language: VBScript
' Originally written in Javascript by: Raphaël Lalonde Lefebvre - Objectif Lune
' *** This macro is provided as is, it will not be supported, and no rights can be claimed ***
' *** Use at your own risk ***
'
' INSTRUCTIONS:
'
' To install, place this .vbs file in "Macro" folder of the PrintShop Mail's directory. If you do not see it, create it. Once done, restart PrintShop Mail,
' and the "TEMPLATE" function will appear.
'
' ****************************************************************************

' Function descriptor.
Function psmGetFunctionDescriptor(index)
	' Descriptor syntax explanation:
	' The first "STRING" is the function's category under which it will appear in the Expression Editor's list of functions.
	' It does not have any impact on what the function returns, it's only used to place it in the right category. Ideally, it will
	' be the same as the function's return type.
	
	' The second "STRING" is the function's return type.

	' Some supported types are:
	' STRING: A string.
	' NUMBER: A number.
	' LOGICAL: True/False value.
	
	' "index" seems to be a PSM system variable, and should be left alone.
	
	if (index = 0) then
		psmGetFunctionDescriptor = "STRING STRING TEMPLATE(STRING{string1;First string.},STRING{string2;Second string.})" & Chr(9) & "Enter function's description here. It is followed by usage examples."  & Chr(9) & "TEMPLATE(""Hello"", ""World"") => Hello World"
	else
		psmGetFunctionDescriptor = ""
	end if
End function

' Main function.
' This is the macro's main code. It should always have "psm" as the prefix.
' If you want a TEMPLATE macro, you need to call the main function "psmTEMPLATE".
' This template's sample code takes 2 strings as parameters, and displays them
' with a space between them.
Function psmTEMPLATE(string1, string2)
	psmTEMPLATE = string1 & " " & string2
End function

' Below are some system functions. They should not be altered unless you know what y
Warning=""
Function psmGetWarning()
	result = Warning
	Warning = ""
	psmGetWarning = result
End function

causeParameterNo = -1
Function psmGetWarningCauseParameter()
	result = causeParameterNo
	causeParameterNo = -1
	psmGetWarningCauseParameter = result
End function

LanguageSet = ""
Function psmSetLanguage(lan)
	LanguageSet = lan
End function