ATL Server Functions

 

Name
Description

AtlCanonicalizeUrl
Call this function to canonicalize a URL, which includes converting unsafe characters and spaces into escape sequences.

AtlCombineUrl
Call this function to combine a base URL and a relative URL into a single, canonical URL.

AtlEscapeUrl
Call this function to convert all unsafe characters to escape sequences.

AtlGetDefaultUrlPort
Call this function to get the default port number associated with a particular Internet protocol or scheme.

AtlGetHexValue
Call this function to get the numeric value of a hexadecimal digit.

AtlHexDecode
Decodes a string of data that has been encoded as hexadecimal text such as by a previous call to AtlHexEncode.

AtlHexDecodeGetRequiredLength
Call this function to get the size in bytes of a buffer that could contain data decoded from a hex-encoded string of the specified length.

AtlHexEncode
Call this function to encode some data as a string of hexadecimal text.

AtlHexEncodeGetRequiredLength
Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.

AtlHexValue
Call this function to get the numeric value of a hexadecimal digit.

AtlImpersonateClient
Call this function to change the current thread's token to impersonate the client making the current request.

AtlIsUnsafeUrlChar
Call this function to find out whether a character is safe for use in a URL.

AtlsHttpError
Call this function to create an HTTP_CODE from an HTTP status code and a subcode.

AtlsSecErrHandlerFunc
This function is used by ATL Server projects as the security error handler that is called in response to a buffer overrun.

AtlUnescapeUrl
Call this function to convert escaped characters back to their original values.

AtlUnicodeToUTF8
Call this function to convert a Unicode string to UTF-8.

Base64Decode
Decodes a string of data that has been encoded in base64 format such as by a previous call to Base64Encode.

Base64DecodeGetRequiredLength
Call this function to get the size in bytes of a buffer that could contain data decoded from a base64-encoded string of the specified length.

Base64Encode
Call this function to base64-encode some data.

Base64EncodeGetRequiredLength
Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.

BEncode
Call this function to convert some data using the "B" encoding.

BEncodeGetRequiredLength
Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.

ClosePerfMon
This function is a Close function that must be provided by performance extension DLLs that expose performance counters.

CollectPerfMon
This function is a Collect function that must be provided by performance extension DLLs that expose performance counters.

CreateRequestHandlerSync
Call this function to create a request handler to handle a synchronous call.

CreateServerContext
Call this function to create a new CServerContext.

EscapeToCString
Call this function to URL-encode a string and have the result appended to a CString passed to the function by reference.

EscapeXML
Call this function to convert characters that are unsafe for use in XML to their safe equivalents.

GetContentTypeFromFileName
Call this function to get the MIME content type of a file based on its name.

GetDataSource
Call this function to retrieve a cached data source or add it to the cache if not already present.

GetExtendedChars
Call this function to get the number of extended characters in a string.

GetScriptFullFileName
Call this function to retrieve the full canonical physical path of a file relative to the current script.

GetStatusHeader
Call this function to obtain a status header (for example, 200 OK) that can be returned in the header of an HTTP response.

IsAsyncContinueStatus
Call this function to determine whether an ATL Server HTTP_CODE status code indicates that asynchronous processing is still in progress.

IsAsyncDoneStatus
Call this function to determine whether an ATL Server status code indicates that asynchronous processing has completed.

IsAsyncFlushStatus
Call this function to determine whether a status code indicates that asynchronous processing has occurred and ATL Server code is responsible for flushing.

IsAsyncNoFlushStatus
Call this function to determine whether a status code indicates that asynchronous processing has occurred and ATL Server code is not responsible for flushing.

IsAsyncStatus
Call this function to determine whether a status code indicates that asynchronous processing has occurred.

IsExtendedChar
Call this function to find out if a given character is an extended character (less than 32, greater than 126, and not a tab, linefeed or carriage return)

IsNullByType
Specialize this function to define what it means for a type to be null when used with CValidateObject.

OpenPerfMon
This function is an Open function that must be provided by performance extension DLLs that expose performance counters.

QEncode
Call this function to convert some data using the "Q" encoding.

QEncodeGetRequiredLength
Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.

QPDecode
Decodes a string of data that has been encoded in quoted-printable format such as by a previous call to QPEncode.

QPDecodeGetRequiredLength
Call this function to get the size in bytes of a buffer that could contain data decoded from quoted-printable-encoded string of the specified length.

QPEncode
Call this function to encode some data in quoted-printable format.

QPEncodeGetRequiredLength
Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.

ReadClientData
Call this function to read data from the client making the current request.

RegisterPerfMon
Call this function to register performance objects and counters.

RemoveDataSource
Call this function to close a cached connection and remove it from the data source cache.

RenderError
Call this function to write an error response to the client.

RGBToHtml
Converts a COLORREF value to the HTML text corresponding to that color value.

RSkipSpace
Returns the pointer to the previous non-whitespace character.

SafeStringCopy
Call this function to copy a string into a fixed size character buffer.

SetRfc822Time
Call this function to get the current system time as a string in RFC 822 format.

SkipSpace
Returns the pointer to the next non-whitespace character.

SystemTimeToHttpDate
Call this function to convert a system time to a string in a format suitable for using in HTTP headers.

UnregisterPerfMon
Call this function to unregister performance objects and counters.

UUDecode
Decodes a string of data that has been uuencoded such as by a previous call to UUEncode.

UUDecodeGetRequiredLength
Call this function to get the size in bytes of a buffer that could contain data decoded from a uuencoded string of the specified length.

UUEncode
Call this function to uuencode some data.

UUEncodeGetRequiredLength
Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.

ATLPath::AddBackslash
This function is an overloaded wrapper for PathAddBackslash.

ATLPath::AddExtension
This function is an overloaded wrapper for PathAddExtension.

ATLPath::Append
This function is an overloaded wrapper for PathAppend.

ATLPath::BuildRoot
This function is an overloaded wrapper for PathBuildRoot.

ATLPath::Canonicalize
This function is an overloaded wrapper for PathCanonicalize.

ATLPath::Combine
This function is an overloaded wrapper for PathCombine.

ATLPath::CommonPrefix
This function is an overloaded wrapper for PathCommonPrefix.

ATLPath::CompactPath
This function is an overloaded wrapper for PathCompactPath.

ATLPath::CompactPathEx
This function is an overloaded wrapper for PathCompactPathEx.

ATLPath::FileExists
This function is an overloaded wrapper for PathFileExists.

ATLPath::FindExtension
This function is an overloaded wrapper for PathFindExtension.

ATLPath::FindFileName
This function is an overloaded wrapper for PathFindFileName.

ATLPath::GetDriveNumber
This function is an overloaded wrapper for PathGetDriveNumber.

ATLPath::IsDirectory
This function is an overloaded wrapper for PathIsDirectory.

ATLPath::IsFileSpec
This function is an overloaded wrapper for PathIsFileSpec.

ATLPath::IsPrefix
This function is an overloaded wrapper for PathIsPrefix.

ATLPath::IsRelative
This function is an overloaded wrapper for PathIsRelative.

ATLPath::IsRoot
This function is an overloaded wrapper for PathIsRoot.

ATLPath::IsSameRoot
This function is an overloaded wrapper for PathIsSameRoot.

ATLPath::IsUNC
This function is an overloaded wrapper for PathIsUNC.

ATLPath::IsUNCServer
This function is an overloaded wrapper for PathIsUNCServer.

ATLPath::IsUNCServerShare
This function is an overloaded wrapper for PathIsUNCServerShare.

ATLPath::MakePretty
This function is an overloaded wrapper for PathMakePretty.

ATLPath::MatchSpec
This function is an overloaded wrapper for PathMatchSpec.

ATLPath::QuoteSpaces
This function is an overloaded wrapper for PathQuoteSpaces.

ATLPath::RelativePathTo
This function is an overloaded wrapper for PathRelativePathTo.

ATLPath::RemoveArgs
This function is an overloaded wrapper for PathRemoveArgs.

ATLPath::RemoveBackslash
This function is an overloaded wrapper for PathRemoveBackslash.

ATLPath::RemoveBlanks
This function is an overloaded wrapper for PathRemoveBlanks.

ATLPath::RemoveExtension
This function is an overloaded wrapper for PathRemoveExtension.

ATLPath::RemoveFileSpec
This function is an overloaded wrapper for PathRemoveFileSpec.

ATLPath::RenameExtension
This function is an overloaded wrapper for PathRenameExtension.

ATLPath::SkipRoot
This function is an overloaded wrapper for PathSkipRoot.

ATLPath::StripPath
This function is an overloaded wrapper for PathStripPath.

ATLPath::StripToRoot
This function is an overloaded wrapper for PathStripToRoot.

ATLPath::UnquoteSpaces
This function is an overloaded wrapper for PathUnquoteSpaces.

See Also

ATL Server | ATL Server Reference | ATL Server Samples