Gets the Boolean after the test for connecting to the data source with the following arguments:

DataSrc—the name of the data source (usually the NETBIOS name of the database server).

DataSrcType—specifies the OLEDB providers supported by this class: adJetOLEDB, adJet4OLEDB, adODBCOLEDB, adOracleOLEDB, adMSSQLOLEDB, adSybaseOLEDB and adUDL.

ConnectType—Specifies the connection behavior of the ADO connection object. Because this is used in ASP, this value should always be set to adConnectSynchronous.

Catalog—Specifies the name of the database for most OLEDB providers.

UserName—Specifies the name of the database user with permission to access the data.

Password—Specifies the password of the database user with permission to access the data.

TIP: By omitting the UserName and Password when calling Connect() for SQL Server 7.x (or MSDE 1.x) on Windows NT/2000, this class will use the NT/2000 login credentials to attempt to connect to the database server.

Gets the Boolean after the test for successfully executing dynamic SQL commands against the ADODB.Connection object with the arguments:

Source—Valid SQL for the DBMS. SQL strings with parameters should contain question marks (?).

Options—An ADODB.CommandTypeEnum. Only adCmdText has been extensively tested.

SQLPrms—This optional value can be an array or delimited string literal corresponding to the parameters required by Source. The string literal must be delimited by vbNullChar characters.

Executes dynamic SQL projections against the ADODB.Connection object and returns a read-only, forward-only ADO Recordset.

This method has the same arguments as CnnCmd().

Returns a disconnected, ADO Recordset (CursorType:=adOpenStatic and LockType:=adLockBatchOptimistic). This method is used to access ADO Recordset methods like MoveFirst() and MovePrevious(), and properties like Recordcount.

This method has the same arguments as CnnCmd().

Gets the Boolean after the test for successfully executing a stored procedure against the ADODB.Command object with the following arguments:

StoredProcName—Contains the name of the stored procedure of the DBMS supported by this Class.

Params—This value can be an array or delimited string literal corresponding to the parameters required by StoredProcName. The string literal must be delimited by vbNullChar characters.

NOTE: This value is passed by reference (ByRef) for stored procedure parameters that return values.

When Has2DparamArray:=True parameters passed as a two-dimensional parameter array can be updated after execution. For example, in Microsoft remote data management systems parameters modified by the OUTPUT keyword will be updated.

The 2D parameter array has the following form:

<param’ name>, <row 0>
<param’ value>, <row 0>
<param’ name>, <row 1>
<param’ value>, <row 1>

etc.

Has2DparamArray—Indicates if Params contains a two-dimensional array. See Params.

TimeOut—The number of seconds to set the CommandTimeout property of the ADO Command object. By default, it is set to 30 seconds.

Executes a stored procedure against the ADODB.Command object and returns a read-only, forward-only ADO Recordset.

This method has the same arguments as StoredProcCmd().

Closes the specified recordset object and sets the object to Nothing with the following argument:

RecSet—The reference to the recordset object.

Gets the Boolean result of the test for successfully writing to a text file with the argument:

FileString—the string literal to write to the file.

A file object must be pre-defined by setting the WebFileName and WebFilePath properties. If the file does not exist, this method will create the file.

Gets/Sets the class attribute of the select element.

By default, the class attribute is not rendered in the HTML.

Gets/Sets the Boolean property that determines if the default value (option) of the select element is selected.

NOTE: The client-side JavaScript function jsGetOptionsIndex() is often used instead of setting this property. See “The \inc\routines\rootData.js File” below.

Gets/Sets the id attribute of the select element.

By default, the id attribute is not rendered in the HTML.

Gets/Sets inline JavaScript used by the select element.

EXAMPLE: To add the onChange attribute to the select element, we have:

Set objCombo = new clsHTMLComboBox
objCombo.JavaScript = _
    "onChange = ""[your code here]"""

You can see how we are using the old VB double-quote trick to render the quotes in HTML. You can also see how free-form this property can be which makes it very dangerous to inexperienced users.

By default, inline JavaScript is not rendered in the HTML.

Gets/Sets the name attribute of the select element.

By default, the name attribute is not rendered in the HTML.

Gets/Sets the Boolean property that determines if this select element has a multiple attribute.

By default, the name attribute is not rendered in the HTML.

Gets/Sets the Boolean property that determines if the column order of the recordset or array is reversed. This means that column 1 sets the value attribute of the option element and column 0 is displayed.

This property is useful for those unfortunate cases when you are not in control of the data being sent to the client from the DBMS.

Gets/Sets the width attribute of the select element. This will also create an inline style attribute setting the CSS width property to make sure it renders on as many browsers as possible.

By default, this property is not used and is usually ignored because of the use of the ClassName property.

Gets/Sets the string literal used to create option elements for the select element. This string literal is a vbNullChar-delimited list in the form:

[value] & vbNullChar & [display text] …

This implies that odd-number values in the list set the value attribute of each option element and even-number values are displayed. This design was chosen more for flexibility than for convenience.

This function truncates the text to be displayed as HTML at the specified length with arguments:

vString—the string to truncate.

vZeroString—the text to display when vString contains a zero-length string.

vLength—the length of the string to display before characters are truncated.

NOTE: Ellipses are appended to the end of a non-zero-length truncated string.

This function returns the Greenwich Mean Time “offset” with respect to Pacific Time. It returns 7 when Pacific Standard Time is detected and 8 when Pacific Daylight Savings Time is detected.

This function is rather useless out of the Pacific time zone. It was developed for writing vCalendar items.

This function returns a one-dimensional array of month names based on the locale settings of the web server with the following argument:

vAbbreviate—Boolean value that indicates if the month name is to be abbreviated based on the locale settings of the web server.

This function returns a one-dimensional array of weekday names based on the locale settings of the web server with the following arguments:

vAbbreviate—Boolean value that indicates if the month name is to be abbreviated based on the locale settings of the web server.

vFirstDay—Numeric value indicating the first day of the week (use these constants for readability: vbUseSystemDayOfWeek, vbSunday, vbMonday, vbTuesday, vbWednesday, vbThursday, vbFriday, vbSaturday).

This function returns a date based on these arguments:

vWeekDay—An integer from1 to 7 corresponding to the day constants vbSunday, vbMonday, vbTuesday, vbWednesday, vbThursday, vbFriday, vbSaturday.

vWeek—An integer indicating the current week on the year (usually from 1 to 52).

vMonth—An integer indicating the current month of the year (usually from 1 to 12).

vYear—The current four-digit year.

vFirstWeekDay—An integer indicating the first day of the week (from 1 to 7 corresponding to the day constants mentioned above.).

NOTE: This function assumes that the first week of the year the week in which January 1 occurs

This function returns the virtual path in the SCRIPT_NAME environment variable as an array or as a scalar identified by vLevel with arguments:

vLevel—The level of the path to return. For example, 0 returns the file name; 1 returns the directory where the file resides.

vReturnArray—Boolean value that determines whether to return the entire array or just a scalar indicated by vLevel.

This function searches an array for a scalar value with arguments:

vArray—The array to be searched.

vItem—The search scalar.

NOTE: This converts the search scalar and each array element to strings for each search attempt.

This function is a server-side browser sniffer with argument vAgent which a string indicating the browser to detect. This is the latest list of targets:

Gecko 5x—Mozilla 5 and above.

MSIE 4x—MS Internet Explorer 4 and above.

MSIE 5x—MS Internet Explorer 5 and above.

Netscape 4x—Netscape 4 and above.

NOTE: Our client-side browser sniffer (rootSniffer.js) from webreference.com should be used for more accurate sniffing.

This function reads the LOGON_USER environment variable and returns a scalar containing the domain name or the user name—or the entire environment variable. The vItem argument determines what is returned:

When vItem="domain" the domain name is returned.

When vItem="user" the user name is returned.

All other values return the unaltered contents of the LOGON_USER environment variable.

This function delays code execution for the amount (in seconds) indicated by vSeconds.

This function is most useful when the Response.Buffer and Response.Flush features of ASP are used.

This JavaScript function returns an integer value indicating the index of one of the option objects in a select object with arguments:

objSelect—The select object as seen by the DOM of the web browser.

vValue_data—The value of the option object in the select object being “bound.”

This data binding function is essentially used to set the selectedIndex property of the select object.

This JavaScript function concatenates the wildcard character (vWildCard) of the DBMS to a search string (vString). The concatenation is determined by a code (vCode) where:

* indicates “containing.”

=* indicates “starting with.”

*= indicates “ending with.”

= indicates “exact.”

This function is made to be a part of a search form.

This JavaScript function returns a Boolean value, testing the validity of email addresses with arguments:

vFormName—The name of form containing the email address input object.

objElement—The email address input object.

This JavaScript function returns a Boolean value, testing for text entered in an input object with arguments:

objElement—The input object being tested.

vMsg—The message to pop up if the text field is not completed (empty).

If the text field is not complete, this function returns true.

This JavaScript function returns a Boolean value, testing for a numeric value entered in an input object. It has the same arguments as jsIsNotComplete().

If the value entered is not numeric, this function returns true.

This JavaScript function returns a Boolean value, testing for an item selected in an input object where type=radio or an item selected other than the default of the select object.

It has the same arguments as jsIsNotComplete() where objElement is the radio or drop-down list box object being tested.

If the item is not selected, this function returns true.

This JavaScript function returns a Boolean value, testing for identical values entered in two input objects of type text with arguments:

objElement1—the first input element to test.

objElement2—the second input element to test.

vMsg—The message to pop up if the text fields do not contain the same value.

If the text fields do not contain the same value, this function returns true.

This JavaScript function returns a Boolean value, testing for the length of text entries into input (type=text) and textarea objects (objElement) against a maximum value (vMaxLength).

If the text entered exceeds the maximum value, this function returns false and pops up an error message (vMsg).

This JavaScript function returns a Boolean value, testing for unique option values selected in a multi-select list with areguments:

objSelect—The select object to test.

vValue_data—The value to use in the test.

If the value is unique, this function returns true.

This function returns the character position of the first character in the search string (argChars) within the string being searched (argStr).

So far, this function is very similar to Instr(). However, the argIterations argument can be used to find the n^th occurrence of the search string.

If argIterations=0 then the position of the last occurrence of argChars is returned.

This function returns a substring out of argStr based on combinations of the arguments:

argStartCol—The starting column of fix-width text to extract. This column is assumed to be column 1.

argEndCol—The ending column of fix-width text to extract. This function extracts what is between the starting and ending columns.

argStartChar—The starting character of text to extract.

argEndChar—The ending character of text to extract.

These arguments can be used in any combination allowing some flexibility and some primitive form of pattern matching. However, this function is to be considered obsolete for those who can use regular expressions. When a particular parameter needs to be “turned off,” use the following default values:

argStartCol = 0
argEndCol = 0
argStartChar = vbNullString
argEndChar = vbNullString

This function returns the line containing argSearchStr, where “line” in the name of the function implies that argStr contains several vbCrLf characters.

In other words, this function responds to the request saying, “Show me the entire line of text containing the search string.”

This function inserts vbCrLf characters at the length (or column) specified by argLineLen in argInpString.

This function was very useful back in the days when lines of text in email messages needed to be a certain length.

Returns the end of a “beginning of HTML file” block. This contains title elements, the end head tag and the beginning body tag.

When an “error page” is called from ASP code this HTML block is useful in making a complete web page. See below for more details.

Returns a complete HTML page by calling this subroutine recursively. This is used mostly for ASP “error pages” so vBlockValue usually contains an HTML-formatted error message.

This kind of call should not be made from an ASP page if the calling page is already rendering HTML.