Library baliCoreUtils

Properties Detail

• DIRECTORY_DELIMITER (Get)

  Public Property Get DIRECTORY_DELIMITER As String
  Returns the appropriate Directory Delimiter for the current Operating System. Checks the current directory in order to determine the DIRECTORY_DELIMITER.

Methods Detail

• columnValStr

  Public Function columnValStr(doc As NotesDocument, colnum As Integer) As String
  One annoying trait of the NotesDocument.columnValues property is that it can return either a scalar or an array. This is annoying, and introduces a potential failure point if you aren't studious enough to make sure you fix this every time you use the columnValues property. This little function takes the column value, and makes sure to always return it as a string, no matter what.
  idx	Argument	Data Type	Attributes	Comments
  1	doc	NotesDocument
  2	colnum	Integer

• columValArray

  Public Function columValArray(doc As NotesDocument, colnum As Integer) As Variant
  One annoying trait of the NotesDocument.columnValues property is that it can return either a scalar or an array. This is annoying, and introduces a potential failure point if you aren't studious enough to make sure you fix this every time you use the columnValues property. This little function takes the column value, and makes sure to always return it as an array, no matter what.
  idx	Argument	Data Type	Attributes	Comments
  1	doc	NotesDocument
  2	colnum	Integer

• fileExists

  Public Function fileExists(filepath As String) As Boolean
  Checks to see if a file exists.
  idx	Argument	Data Type	Attributes	Comments
  1	filepath	String		filepath to check for existence.

• getElementCount

  Public Function getElementCount(source As Variant) As Long
  Gets the number of elements in a list or array
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant

• getListSize

  Public Function getListSize(source As Variant) As Long
  Gets the size number of elements in a list
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant

• getListTags

  Public Function getListTags(source As Variant) As Variant
  Gets the listTags for a list
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		List object from which to get the list tags

• getScalar

  Public Function getScalar(source As Variant) As Variant
  Gets the scalar value of a variable. If an array or a list gets the first value.
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		Variable from which to get the scalar value.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_OPERATION_FAILED	1000	if unable to resolve

• isBlankString

  Public Function isBlankString(source As String) As Boolean
  Tests a string for "blankness" Whitespace is counts a blank
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to test

• isEven

  Public Function isEven(source As Integer) As Boolean
  Tests and integer to determine if it is evenly divisible by 2
  idx	Argument	Data Type	Attributes	Comments
  1	source	Integer		Integer value to test

• isTrue

  Public Function isTrue(source As Variant) As Boolean
  Tests a variable to see if it represents a True value. The following are considered True values: 1, "true", "yes", "y", "t", "enabled"
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		Variant that can be interpreted as either a true or a false value. Tests the scalar value of source.

• makeDirectory

  Public Function makeDirectory(target As String) As Boolean
  Conditionally attempts to create a directory in the filesystem. Checks for the existence of a directory and if it does not exist attempts to create it.
  idx	Argument	Data Type	Attributes	Comments
  1	target	String		Directory to create.

• sortArray

  Public Function sortArray(sArray As Variant, orderflag As String) As Boolean
  SortArray(sArray As Variant, orderflag As String) As Boolean >> Sorts the provided array in either ascending or descending order, based on the order flag: A sorts ascending, D sorts descending. It is also optimized to use a Bubble sort for smaller arrays, and an Insertion Sort for larger arrays. >> This function uses four private subs to do the "work": -- DoQS_A == Quick, or Bubble Sort - ascending; -- DoQS_D == Quick, or Bubble Sort - descending; -- DoInsertSort_A == Insertion Sort, ascending; -- DoInsertSort_D == Insertion Sort - descending; Original QuickSort function written by Richard Dickinson, and used with permission. Modified by Rocky Oliver (Sapphire Oak Technologies) to optimize code and add descending choice
  idx	Argument	Data Type	Attributes	Comments
  1	sArray	Variant		Array to be sorted
  2	orderflag	String		A sorts ascending, D sorts descending.

• strCmp

  Public Function strCmp(string1 As String, string2 As String) As Boolean
  Shorthand method for a Case Insensitive, Pitch insensitive StrCompare call. Flag = (0 = strCompare(string1, string2, 5))
  idx	Argument	Data Type	Attributes	Comments
  1	string1	String	ByVal	Any String expression
  2	string2	String	ByVal	Any String expression

• writeTextFile

  Public Function writeTextFile(source As String, target As String) As Long
  Writes text to a file. IMPORTANT NOTE: Existing files will be OVERWRITTEN! It is up to the calling code to pre-check for existence of file.
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		Text to be written to a file.
  2	target	String		Filepath of file to be written.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if target filepath is blank.
  MSG_OPERATION_FAILED	1000	or other file system exception on failure.

• shellSortIntegers

  Public Sub shellSortIntegers(source As Variant)
  Performs a "divide and conquer" sort of a Integer Array, based on an insertion sort algorithm.
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		Array of Integers to be sorted. This is an IN-OUT argument, passed by reference.

• trimString

  Public Sub trimString(target As String)
  Removes leading and trailing spaces from a string. Pattern replacement for mystring$ = Trim$(mystring$)
  idx	Argument	Data Type	Attributes	Comments
  1	target	String		String to be trimmed