BASIC INTRODUCTION

In addition to a few common parameters, these tags returns a couple variables back no matter what you do. These are always available unless there is a catastrophic failure of the tag.

All functions are called through the ACTION tag. If you don't specify the action tag nothing will be done except some default variables will be set.

You can set the default name of returned SQL queries by using the QUERY parameter.

These tags return data as SQL Queries which you can use like you would any query to a database. By default the name of the query returned is the same as the name of the tag itself. That is, if you are using CFX_IIS the default query name is "IIS". If you are using CFX_Users it is "Users". And so on.

You can override the default name by using the QUERY argument such as: <CFX_NetworkTopology ACTION="Computers" QUERY="myComputers">

( Yes, Cold Fusion generally uses NAME to specify a new query and QUERY to reference an existing query. The way these tags use QUERY is a bit out of sync with CF customs in this regard, but it's less confusing in other ways. )

All tags return a string containing all the error messages they accumulate during their run. In general these errors are not simply informational, but reflect that the function you attempted to execute failed for one reason or another and no (or only partial) action was taken.

Error messages include the line number in the c++ source code where the error occured (to help the programmer debug the situation if it is not simply something on your end -- one of your servers is on fire, etc) as well as the version of the tag and a rather verbose low-level description of the problem. If you are certified in networking, etc then a lot of error messages will immediately hint you in to as what the problem is and whether if you can fix it yourself.

Error messages are cumulative. That is, for example, if you are using CFX_NetworkTopology to list all of the services running on all of the computers in your network, but many of the machines have not granted permission to have their service status queried, then you will receive a large error message showing every single instance where permission was denied.

This variable is blank if there were no (relevant) errors.

The number of seconds the tag was processing. This is computed as the actual difference between when the tag is called and when it finishes.

This is a general description of the tag, the same as the ABOUT function of each tag returns. Not useful in and of itself, it can however be used to determine if the reason nothing is working today is that you've accidently installed an old, expired evaluation version.

This tag will also echo back many common variables you send to it with [tag name] prefix. That is, if you use the parameter "Server" with the tag CFX_IIS to perform a certain function, then a variable will be set called "IISServer".

As a general rule, most parameters designated as "required" will be echoed back in this way.

As of IHTK version 3.8 password protection for use in shared (hosting) environments is available. The included program IHTKPASSWORD.EXE can set or remove a password that is required to be supplied before any CFX tag's function will operate. Use the argument IHTKPASSWORD to pass the password to the tag.

For example, if you're mainly using CFX_IIS say you (the administrator) run the IHTKPASSWORD.EXE program and set the password to "2001201020363001". From then on out any code on this machine that uses CFX_IIS will cease to function as is. If there is anyone on the machine you wish to use CFX_IIS, tell them the current shared environment password to use with the IHTKPASSWORD arg, such as:

The IHTKPASSWORD program is a GUI application that can only be run at the machine in question. It stores the password in the Windows Registry, not in a file. It is assumed that on any machine where an access password would be required that CFREGISTRY would also be disabled.

IHTKPASSWORD.EXE can be found in the ihtkpassword\release\ subfolder.