ATL Server Macros
Visual Studio .NET 2003
The following macros are included in the ATL Server Library.
| Name | Description |
|---|---|
| _ATL_DLLCACHE_MANAGEMENT | Define this macro to enable management services for the ISAPI extension's DLL cache. |
| _ATL_DLLCACHE_NOUI | Define this macro to remove the request handler implementing the HTML interface for managing the ISAPI extension's DLL cache. |
| _ATL_DLLCACHE_NOWEBSERVICE | Define this macro to remove the request handler implementing the SOAP interface for managing the ISAPI extension's DLL cache. |
| _ATL_PERF_REGISTER | This macro activates the registration of performance monitoring components with the Windows operating system. |
| _ATL_SOAP_NO_PARAMETER_VALIDATIONS | Define this macro to turn off SOAP parameter validation. |
| _ATL_STENCILCACHE_MANAGEMENT | Define this macro to enable management services for the ISAPI extension's stencil cache. |
| _ATL_STENCILCACHE_NOUI | Define this macro to remove the request handler implementing the HTML interface for managing the ISAPI extension's stencil cache. |
| _ATL_STENCILCACHE_NOWEBSERVICE | Define this macro to remove the request handler implementing the SOAP interface for managing the ISAPI extension's stencil cache. |
| _ATL_THREADPOOL_MANAGEMENT | Define this macro to enable management services for the ISAPI extension's thread pool. |
| _ATL_THREADPOOL_NOUI | Define this macro to remove the request handler implementing the HTML interface for managing the ISAPI extension's thread pool. |
| _ATL_THREADPOOL_NOWEBSERVICE | Define this macro to remove the request handler implementing the SOAP interface for managing the ISAPI extension's thread pool. |
| ATL_BASE64 Flags | These flags describe how base64-encoding is to be performed by Base64Encode. |
| ATL_BLOB_CACHE_TIMEOUT | This macro defines the cache maintenance frequency for the CBlobCache implementation. |
| ATL_CACHE_KEY_LENGTH | This macro defines the maximum length of a string used as a cache key. |
| ATL_CRITICAL_ISAPI_ERROR_LOGONLY | Define this macro to ensure that critical ISAPI extension errors are only logged in the Windows Event Log and are not returned as HTTP responses. |
| ATL_DEBUG_STENCILS | Define this macro to allow stencil-parsing errors found by CStencil-derived classes to be output when the stencil is rendered. |
| ATL_DEFAULT_AUTHGRP | This macro defines the group used for authorizing access to ATL Server extension management services. Only members of this group can use the Web-based management interfaces to configure the behavior of ATL Server ISAPI extension DLLs. |
| ATL_DEFAULT_DLL_EXTENSION | This macro defines the default file extension used to identify request handler DLLs. |
| ATL_DEFAULT_PRECISION | This macro defines the default precision used by CWriteStreamHelper for writing floating-point values. |
| ATL_DEFAULT_STENCIL_EXTENSION | This macro defines the default file extension used to identify server response files. |
| ATL_DLL_CACHE_TIMEOUT | This macro defines the default value in milliseconds used as the timeout for the DLL cache. The timeout value determines the frequency with which the DLL cache is swept for stale entries. |
| ATL_DS_CONN_STRING_LEN | This macro defines the maximum length of data source connection names. |
| ATL_EPSILON | This macro defines a small value used by CAtlValidator for comparing the equality of floating-point numbers. |
| ATL_ESC Flags | These flags are used to control the behavior of EscapeXML. |
| ATL_FILE_CACHE_TIMEOUT | This macro defines the cache maintenance frequency for the CFileCache implementation. |
| ATL_HTTP Flags | These flags provide information that can be used to modify the behavior of CAtlHttpClientT. |
| ATL_HTTP_AUTHTYPE_BASIC | This macro defines a string that can be used to indicate the BASIC HTTP authorization scheme. |
| ATL_HTTP_AUTHTYPE_NTLM | This macro defines a string that can be used to indicate the NTLM authorization scheme. |
| ATL_HTTP_DEFAULT_BLOCK_SIZE | This macro represents the default memory block sizes used for both incoming and out-going HTTP transaction buffers. |
| ATL_HTTP_FLAG_AUTO_REDIRECT | This macro is a behavior modification flag for HTTP request transactions that specifies whether redirections should be pursued automatically. |
| ATL_HTTP_FLAG_INVALID_FLAGS | This macro can be used to test for an invalid state of the HTTP behavior-control flags used by the CAtlNavigateData and CAtlHttpClientT classes. |
| ATL_HTTP_FLAG_PROCESS_RESULT | This macro is a behavior modification flag for HTTP request transactions that specifies whether additional actions, such as redirection or authorization, should be pursued. |
| ATL_HTTP_FLAG_SEND_BLOCKS | This macro is a behavior modification flag that indicates default HTTP request behavior. |
| ATL_HTTP_FLAG_SEND_CALLBACK | This macro is a behavior modification flag that specifies whether HTTP requests should be chunk-transfer encoded. |
| ATL_HTTP_METHOD_GET | This macro defines a string that indicates HTTP requests based on the GET method. |
| ATL_HTTP_METHOD_POST | This macro defines a string that indicates HTTP requests based on the POST method. |
| ATL_HTTP_PARAM_MAP_CASEINSENSITIVE | Define this macro to treat request parameters in a case insensitive manner. |
| ATL_HTTP_PARAM_MULTIMAP | Define this macro to allow multiple request parameters or form fields with the same name to be stored. |
| ATL_HTTP_USERAGENT | This macro defines the user agent string that is embedded into each request. |
| ATL_INVALID_STATUS | This macro defines a value that represents an invalid HTTP response status code. |
| ATL_ISAPI_BUFFER_SIZE | This macro defines the initial size in bytes of the static buffer used by CAtlIsapiBuffer. |
| ATL_MAX_BLOCK_STACK | This macro defines the maximum number of levels that can be used for nesting replacement tags. |
| ATL_MAX_HANDLER_NAME_LEN | This macro defines the maximum length that can be used for the alias of a subhandler in a subhandler tag. |
| ATL_MAX_METHOD_NAME_LEN | This macro defines the maximum length that can be used for the name of a replacement method. |
| ATL_NO_ACLAPI | Define this macro to prevent inclusion of the Access Control List API headers. |
| ATL_NO_CRITICAL_ISAPI_ERROR | Define this macro to prevent critical ISAPI extension errors being logged in the Windows Event Log. |
| ATL_NO_DEFAULT_AUTHORITY | Define this macro to disable or customize authorization of users of ATL Server extension management services. |
| ATL_NO_MLANG | Define this macro to prevent inclusion of mlang.h and use of the multilanguage object. |
| ATL_NO_MMSYS | Define this macro to prevent inclusion of the Multimedia API headers. |
| ATL_NO_SOAP | Define this macro to turn off any SOAP support. |
| ATL_PERF_CACHE_OBJECT | This macro defines the ID for the cache performance monitoring object definition. |
| ATL_SESSION_SWEEPER_TIMEOUT | This macro defines the frequency at which session data is maintained, in milliseconds. |
| ATL_SESSION_TIMEOUT | This macro defines the time, in milliseconds, after which an unaccessed session expires. |
| ATL_SHAREDBLOBCACHE_TIMEOUT | This macro defines the default value in 100-nanosecond intervals used as a timeout by CSharedCache and CSharedCacheHandler. |
| ATL_SOCK_TIMEOUT | This macro defines the default value in milliseconds used as a timeout by CAtlHttpClient. |
| ATL_STENCIL_CACHE_TIMEOUT | This macro defines the default value in milliseconds used as the timeout for the stencil cache. The timeout value determines the frequency with which the stencil cache is swept for stale entries. |
| ATL_STENCIL_CHECK_TIMEOUT | This macro defines the frequency with which ATL Server checks cached stencils against the raw stencil file to determine if the cached version is out of date. |
| ATL_STENCIL_LIFESPAN | This macro defines a default filetime value used as the life span for stencils in the stencil cache. Stencils are removed from the cache when their life span has been reached whether or not they have been used recently. |
| ATL_URL Flags | These flags modify the behavior of AtlEscapeUrl and AtlCanonicalizeUrl . |
| ATL_URL_DEFAULT_HTTP_PORT | This macro defines the default port used for HTTP transactions. |
| ATL_WORKER_THREAD_WAIT | This macro defines the default value in milliseconds that CWorkerThread::Shutdown will wait for the worker thread to shut down. |
| ATLPERF_DEFAULT_MAXINSTNAMELENGTH | Use this macro to define the maximum name length of object instance strings. |
| ATLS_ASYNC_MUTEX_TIMEOUT | This macro defines the maximum timeout in milliseconds for the asynchronous guard mutex. |
| ATLS_DEFAULT_THREADPOOLSHUTDOWNTIMEOUT | This macro defines the default time in milliseconds that CThreadPool will wait for a thread to shut down. |
| ATLS_DEFAULT_THREADSPERPROC | This macro defines the default number of threads per processor used by CThreadPool. |
| ATLS_ENABLE_DEBUGGING | Define this macro before including atlisapi.h to enable the debugger to automatically attach to the Web server in release builds. |
| ATLS_NO_ERR_LOGGING | Define this macro to prevent buffer overrun errors being logged in the Windows Event Log. |
| ATLS_WORKER_HEAP_SIZE | This macro defines the initial size of the heap used by CIsapiWorker. |
| ATLSMTP_QPENCODE Flags | These flags describe how quoted-printable encoding is to be performed by QPEncode. |
| ATLSMTP_UUENCODE Flags | These flags describe how uuencoding is to be performed by UUEncode. |
| ATLSOAP_NOWININET | Define this macro before including atlsoap.h to ensure that including this header does not introduce a dependency on WinInet into your project. |
| BEGIN_COUNTER_MAP | Use this macro to begin performance counter definition maps within CPerfObject-derived classes. |
| BEGIN_HANDLER_MAP | Use this macro in a request handler DLL to mark the start of a handler map. |
| BEGIN_PERF_MAP | Use this macro to preface performance object map definitions. |
| BEGIN_REPLACEMENT_METHOD_MAP | Use this macro in a request handler class to mark the start of a replacement method map. |
| CHAIN_PERF_OBJECT | Use this macro to attach a performance object class to a performance object management class (a class derived from CPerfMon). |
| DECLARE_ASYNC_HANDLER_EX | Add this macro to the class definition of your request handler if you need to write to the client asynchronously. |
| DECLARE_ASYNC_HANDLER | Add this macro to the class definition of your request handler if you need to write to the client asynchronously. |
| DECLARE_PERF_OBJECT_EX | Use this macro to declare a new performance object from within a CPerfObject-derived class. |
| DECLARE_PERF_OBJECT_NO_INSTANCES | Use this macro to declare a new instanceless performance object from within a CPerfObject-derived class. |
| DECLARE_PERF_OBJECT | Use this macro to declare a new performance object from within a CPerfObject-derived class. |
| DECLARE_REQUEST_HANDLER | Add this macro to your project to map a request handler name to the class responsible for handling the corresponding requests. |
| DEFAULT_MAX_FORM_SIZE | This macro defines the default maximum form size in bytes. |
| DEFINE_COUNTER_EX | Use this macro to define performance monitor counters within CPerfMon-derived classes. |
| DEFINE_COUNTER | Use this macro to define performance monitor counters within CPerfMon-derived classes. |
| END_COUNTER_MAP | Use this macro to terminate performance counter map definitions. |
| END_HANDLER_MAP | Use this macro in a request handler DLL to mark the end of a handler map. |
| END_PERF_MAP | Use this macro to end a performance map. |
| END_REPLACEMENT_METHOD_MAP | Use this macro in a request handler class to mark the end of a replacement method map. |
| Handler Flags | These macros are used as flags to be returned from a request handler's GetHandlerFlags method. |
| HANDLER_ENTRY_EX | This macro is a synonym for the DECLARE_REQUEST_HANDLER macro. |
| HANDLER_ENTRY_SDL | Add this macro to your project to map a request handler name to the class responsible for handling the corresponding requests and expose the Web Service Description Language (WSDL) for the handler. |
| HANDLER_ENTRY | This macro is a synonym for the DECLARE_REQUEST_HANDLER macro. |
| HTTP_CODE Status Codes | These macros provide symbols for commonly used ATL Server status codes. |
| HTTP_CODE Subcodes | These macros are used as subcodes to control the actions that the ATL Server framework takes when returning from a request handler method or to distinguish one error code from another. |
| HTTP_ERROR_CODE | Use this macro to get the HTTP status code from an ATL Server status code. |
| HTTP_ERROR | Use this macro to create an HTTP_CODE from an HTTP status code and a subcode. |
| HTTP_SUBERROR_CODE | Use this macro to get the subcode from an ATL Server status code. |
| ID_DLLCACHEMGR_SRFHANDLER_NAME | This constant defines the name of the request handler that implements the HTML interface for managing the DLL cache. |
| ID_DLLCACHEMGR_WEBSERVICE_NAME | This constant defines the name of the XML Web service that exposes the SOAP interface for managing the DLL cache and the request handler that implements it. |
| ID_DLLCACHEMGR_WEBSERVICE_URL | This constant defines the namespace of the XML Web service that exposes the SOAP interface for managing the DLL cache. |
| ID_DLLCACHEMGR_WEBSERVICE_WSDL | This constant defines the name of the WSDL handler for the XML Web service that exposes the SOAP interface for managing the DLL cache. |
| ID_STENCILCACHEMGR_SRFHANDLER_NAME | This constant defines the name of the request handler that implements the HTML interface for managing the stencil cache. |
| ID_STENCILCACHEMGR_WEBSERVICE_NAME | This constant defines the name of the XML Web service that exposes the SOAP interface for managing the stencil cache and the request handler that implements it. |
| ID_STENCILCACHEMGR_WEBSERVICE_URL | This constant defines the namespace of the XML Web service that exposes the SOAP interface for managing the stencil cache. |
| ID_STENCILCACHEMGR_WEBSERVICE_WSDL | This constant defines the name of the WSDL handler for the XML Web service that exposes the SOAP interface for managing the stencil cache. |
| ID_THREADMGR_SRFHANDLER_NAME | This constant defines the name of the request handler that implements the HTML interface for managing the thread pool. |
| ID_THREADMGR_WEBSERVICE_NAME | This constant defines the name of the XML Web service that exposes the SOAP interface for managing the thread pool and the request handler that implements it. |
| ID_THREADMGR_WEBSERVICE_URL | This constant defines the namespace of the XML Web service that exposes the SOAP interface for managing the thread pool. |
| ID_THREADMGR_WEBSERVICE_WSDL | This constant defines the name of the WSDL handler for the XML Web service that exposes the SOAP interface for managing the thread pool. |
| IDR_DLLMGR_SRF | This constant defines the name of the stencil resource that provides the HTML interface for managing the DLL cache. |
| IDR_STENCILMGR_SRF | This constant defines the name of the stencil resource that provides the HTML interface for managing the stencil cache. |
| IDR_THREADMGR_SRF | This constant defines the name of the stencil resource that provides the HTML interface for managing the thread pool. |
| MAX_CONNECTION_STRING_LEN | This macro defines the maximum length of the data source connection string used for session-state data storage. |
| MAX_SESSION_KEY_LEN | This macro defines the maximum size allowed for a session name, in bytes. |
| MAX_TOKEN_LENGTH | This macro defines the maximum allowed size in bytes for the name of an HTML form element that can be handled by ATL Server. |
| MAX_VARIABLE_NAME_LENGTH | This macro is defines the maximum size of session-state data variable names. |
| MAX_VARIABLE_VALUE_LENGTH | This macro is defines the maximum size of session-state data values. |
| NO_ATL_MGMT_STENCIL_WARNING | Define this macro before including atlextmgmt.h to prevent a message being displayed during compilation to remind you to include stencil resources for the HTML interface used by the extension management services. |
| PERFREG_ENTRY | Use this macro to register CPerfMon-derived classes with the Windows performance monitoring subsystem. |
| REPLACEMENT_METHOD_ENTRY_EX_STR | Use this macro in a replacement method map to associate a replacement method with a particular tag name. Use when the replacement method needs to receive method arguments in the form of a char* parameter. |
| REPLACEMENT_METHOD_ENTRY_EX | Use this macro in a replacement method map to associate a replacement method with a particular tag name. Use when the replacement method needs to receive method arguments. |
| REPLACEMENT_METHOD_ENTRY | Use this macro in a replacement method map to associate a replacement method with a particular tag name. |
| Request Initialization Flags | These macros are used as flags to be returned from a request handler's GetFlags method. |
| SESSION_COOKIE_NAME | This macro is used as the name of the cookie used for tracking session-state data. |
| Stencil Tokens | These constants identify different tokens recognized by the CStencil and CHtmlStencil classes. |
| STENCIL_USER_TOKEN_BASE | Use this value as the starting point for constants used to identify custom tokens in CStencil-derived classes. |
| Validation Results | These macros are returned as results from the Exchange or Validate methods of CValidateObject. |
| VALIDATION_SUCCEEDED | Use this macro to determine whether validation succeeded or failed. |
See Also
ATL Server | ATL Server Reference | ATL Server Samples
