EfficiencySpring Coder's Guide

API Shared Functions and Subroutines

EfficiencySpring's API has several shared functions available that provide significant amounts of pre-built functionality. This page will list some of the more valuable functions; you may browse the XML API documentation through Visual Studio for a more complete list of functions and subroutines.

EfficiencyCommon.Utilities.Formatters

Function/Subroutine	Description
MD5(passed string)	Encrypts a passed in string using MD5 encryption.
PrepString(passed string)	A formatting function for SQL string literals, this function replaces single quotes with double single quotes.
PrepStringQ(passed string)	A formatting function for SQL string literals, this function replaces single quotes with double single quotes and surrounds the resulting string with "N'" and "'". PrepStringQ also returns the value " NULL " if the passed in string is empty.
PrepDateQ(passed string)	A formatting function for SQL date literals, this function replaces single quotes with double single quotes and surrounds the resulting string with "'" and "'". PrepDateQ also returns the value " NULL " if the passed in string is empty.
PrepJsString(passed string)	A formatting function for JavaScript string literals, this function preps a server-side string for rendering within a client-side JavaScript string, escaping out "'", "\", """, as well as replacing tab characters and line feeds with the JavaScript string switches \t and \n.
HandleNull(Value as object, ReturnValue as DateTime / Integer / Decimal / String / Boolean)	This overloaded function evaluates the first passed in parameter and returns the passed in ReturnValue if the first parameter is null.
QsReplace(QueryString, Parameter, Replacement Value)	This function is utilized to replace any parameter in a querystring with a new value, as well as add the parameter to the querystring if necessary.
ConvertUserDateFormatToSystemFormat(passed User object, DateString)	This function converts the format of a user-entered date into the standard US formatted date used by EfficiencySpring.
ConvertSystemDateFormatToUserFormat(passed User object, DateString)	This function converts the format of a standard US date into the date format of the passed in user.
ConvertGmtDateToUserTimezone(passed User object, DateString)	This function converts a GMT timezone date to the user's timezone, based on either live-feedback from the user's browser or a cached hourly offset.
ConvertGmtDateToUserFormatAndTimezone(passed User object, DateString)	This function converts a GMT timezone date to the user's timezone, based on either live-feedback from the user's browser or a cached hourly offset. The function also converts the format of the date from the standard US format to the user's format.
ConvertUserDateToGmtTimezone(passed User object, DateString)	This functions converts a user inputted date to the GMT timezone, based on either live-feedback from the user's browser or a cached hourly offset.

EfficiencyCommon.Utilities.Keys

Function/Subroutine	Description
GetNextKeyValue(table name, key field, optional connection namespace)	This function returns the next ID available for the passed in table name from the ID_Table

EfficiencyCommon.Utilities.Mailer

Function/Subroutine	Description
SendHTMLMailMessage(from, to, subject, body, cc, bcc, attachment, readerprovider)	This subroutine sends an HTML formatted email.
SendTextMailMessage(from, to, subject, body, cc, bcc, attachment, readerprovider)	This subroutine sends a plain-text email.