ATL Functions Alphabetical Reference

Article
2013-01-30

In this section, reference topics for the ATL global functions are organized alphabetically. To find a particular function by category, see ATL Functions.

Function	Description
AtlAdvise	Creates a connection between an object's connection point and a client's sink.
AtlAdviseSinkMap	Call this function to advise or unadvise all entries in the object's sink event map.
AtlAxAttachControl	Attaches a previously created control to the specified window.
AtlAxCreateControlEx	Creates an ActiveX control, initializes it, and hosts it in the specified window. An interface pointer and event sink for the new control can also be created.
AtlAxCreateControlLicEx	Creates a licensed ActiveX control, initializes it, and hosts it in the specified window. An interface pointer and event sink for the new control can also be created.
AtlAxCreateControlLic	Creates a licensed ActiveX control, initializes it, and hosts it in the specified window.
AtlAxCreateControl	Creates an ActiveX control, initializes it, and hosts it in the specified window.
AtlAxCreateDialog	Creates a modeless dialog box from a dialog template provided by the user.
AtlAxDialogBox	Creates a modal dialog box from a dialog template provided by the user.
AtlAxGetControl	Obtains a direct interface pointer to the control contained inside a specified window given its handle.
AtlAxGetHost	Obtains a direct interface pointer to the container for a specified window (if any), given its handle.
AtlAxWinInit	This function initializes ATL's control hosting code by registering the "AtlAxWin80" and "AtlAxWinLic80" window classes plus a couple of custom window messages.
AtlAxWinTerm	This function uninitializes ATL's control hosting code by unregistering the "AtlAxWin80" and "AtlAxWinLic80" window classes.
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.
AtlComModuleGetClassObject	This function is called to return the class factory.
AtlComModuleRegisterClassObjects	This function is called to register class objects.
AtlComModuleRegisterServer	This function is called to register every object in the object map.
AtlComModuleRevokeClassObjects	This function is called to remove the class factory/factories from the Running Object Table.
AtlComModuleUnregisterServer	This function is called to unregister every object in the object map.
AtlComPtrAssign	Assigns an interface pointer to another interface pointer of the same type.
AtlComQIPtrAssign	Assigns an interface pointer to another interface pointer of a different type.
AtlCreateTargetDC	Creates a device context for the device specified in the DVTARGETDEVICE structure.
AtlEscapeUrl	Call this function to convert all unsafe characters to escape sequences.
AtlFreeMarshalStream	Releases the marshal data in the stream, then releases the stream pointer.
AtlGetDacl	Call this function to retrieve the discretionary access-control list (DACL) information of a specified object.
AtlGetDefaultUrlPort	Call this function to get the default port number associated with a particular Internet protocol or scheme.
AtlGetGroupSid	Call this function to retrieve the group security identifier (SID) of an object.
AtlGetHexValue	Call this function to get the numeric value of a hexadecimal digit.
AtlGetObjectSourceInterface	Call this function to retrieve information about the default source interface of an object.
AtlGetOwnerSid	Call this function to retrieve the owner security identifier (SID) of an object.
AtlGetPerUserRegistration	Use this function to determine whether the application redirects registry access to the HKEY_CURRENT_USER (HKCU) node.
AtlGetSacl	Call this function to retrieve the system access-control list (SACL) information of a specified object.
AtlGetSecurityDescriptor	Call this function to retrieve the security descriptor of a given object.
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.
AtlHiMetricToPixel	Converts an object's size in HIMETRIC units (each unit is 0.01 millimeter) to a size in pixels on the screen device.
AtlHresultFromLastError	Returns the calling thread's last-error code value in the form of an HRESULT.
AtlHresultFromWin32	Converts a Win32 error code into an HRESULT.
AtlInternalQueryInterface	Retrieves a pointer to the requested interface.
AtlIsUnsafeUrlChar	Call this function to find out whether a character is safe for use in a URL.
AtlLoadTypeLib	This function is called to load a type library.
AtlMarshalPtrInProc	Creates a new stream object, writes the CLSID of the proxy to the stream, and marshals the specified interface pointer by writing the data needed to initialize the proxy into the stream.
AtlModuleRegisterServer	Registers every object in the object map.
AtlModuleRegisterTypeLib	Registers a type library.
AtlModuleUnregisterServerEx	Unregisters every object in the object map.
AtlModuleUnregisterServer	Unregisters every object in the object map. It is similar to AtlModuleUnregisterServerEx except that it cannot unregister the type library.
AtlModuleUnregisterTypeLib	Unregisters a type library.
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.
AtlPixelToHiMetric	Converts an object's size in pixels on the screen device to a size in HIMETRIC units (each unit is 0.01 millimeter).
AtlRegisterTypeLib	This function is called to register a type library.
AtlReportError	Sets up the IErrorInfo interface to provide error information to clients of the object.
AtlSetChildSite	Call this function to set the site of the child object to the IUnknown of the parent object.
AtlSetDacl	Call this function to set the discretionary access-control list (DACL) information of a specified object.
AtlSetGroupSid	Call this function to set the group security identifier (SID) of an object.
AtlSetOwnerSid	Call this function to set the owner security identifier (SID) of an object.
AtlSetPerUserRegistration	Sets whether the application redirects registry access to the HKEY_CURRENT_USER (HKCU) node.
AtlSetSacl	Call this function to set the system access-control list (SACL) information of a specified object.
AtlThrowLastWin32	Call this function to signal an error based on the result of the Windows function GetLastError.
AtlThrow	Call this function to signal an error based on a HRESULT status code.
AtlTraceLoadSettings	Call this function to load trace settings from a file.
AtlTraceSaveSettings	Call this function to save the current trace settings to a file.
AtlUnadvise	Terminates the connection established through AtlAdvise.
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.
AtlUnmarshalPtr	Converts the stream's marshaling data into an interface pointer that can be used by the client.
AtlUnRegisterTypeLib	This function is called to unregister a type library.
AtlUpdateRegistryFromResourceD	This function is called to update the registry from the supplied resource.
AtlWaitWithMessageLoop	Waits for the object to be signaled, meanwhile dispatching window messages as needed.
AtlWinModuleAddCreateWndData	This function is used to initialize and add an _AtlCreateWndData structure.
AtlWinModuleExtractCreateWndData	Call this function to extract an existing _AtlCreateWndData structure.
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.
EscapeXML	Call this function to convert characters that are unsafe for use in XML to their safe equivalents.
GetExtendedChars	Call this function to get the number of extended characters in a string.
InlineIsEqualIUnknown	Call this function, for the special case of testing for IUnknown.
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)
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.
RegistryDataExchange	This function is called to read from, or write to, the system registry.
RGBToHtml	Converts a COLORREF value to the HTML text corresponding to that color value.
Sids::AccountOps	Returns the DOMAIN_ALIAS_RID_ACCOUNT_OPS SID.
Sids::Admins	Returns the DOMAIN_ALIAS_RID_ADMINS SID.
Sids::AnonymousLogon	Returns the SECURITY_ANONYMOUS_LOGON_RID SID.
Sids::AuthenticatedUser	Returns the SECURITY_AUTHENTICATED_USER_RID SID.
Sids::BackupOps	Returns the DOMAIN_ALIAS_RID_BACKUP_OPS SID.
Sids::Batch	Returns the SECURITY_BATCH_RID SID.
Sids::CreatorGroupServer	Returns the SECURITY_CREATOR_GROUP_SERVER_RID SID.
Sids::CreatorGroup	Returns the SECURITY_CREATOR_GROUP_RID SID.
Sids::CreatorOwnerServer	Returns the SECURITY_CREATOR_OWNER_SERVER_RID SID.
Sids::CreatorOwner	Returns the SECURITY_CREATOR_OWNER_RID SID.
Sids::Dialup	Returns the SECURITY_DIALUP_RID SID.
Sids::Guests	Returns the DOMAIN_ALIAS_RID_GUESTS SID.
Sids::Interactive	Returns the SECURITY_INTERACTIVE_RID SID.
Sids::Local	Returns the SECURITY_LOCAL_RID SID.
Sids::Network	Returns the SECURITY_NETWORK_RID SID.
Sids::NetworkService	Returns the SECURITY_NETWORK_SERVICE_RID SID.
Sids::Null	Returns the SECURITY_NULL_RID SID.
Sids::PowerUsers	Returns the DOMAIN_ALIAS_RID_POWER_USERS SID.
Sids::PreW2KAccess	Returns the DOMAIN_ALIAS_RID_PREW2KCOMPACCESS SID.
Sids::PrintOps	Returns the DOMAIN_ALIAS_RID_PRINT_OPS SID.
Sids::Proxy	Returns the SECURITY_PROXY_RID SID.
Sids::RasServers	Returns the DOMAIN_ALIAS_RID_RAS_SERVERS SID.
Sids::Replicator	Returns the DOMAIN_ALIAS_RID_REPLICATOR SID.
Sids::RestrictedCode	Returns the SECURITY_RESTRICTED_CODE_RID SID.
Sids::Self	Returns the SECURITY_PRINCIPAL_SELF_RID SID.
Sids::ServerLogon	Returns the SECURITY_SERVER_LOGON_RID SID.
Sids::Service	Returns the SECURITY_SERVICE_RID SID.
Sids::SystemOps	Returns the DOMAIN_ALIAS_RID_SYSTEM_OPS SID.
Sids::System	Returns the SECURITY_LOCAL_SYSTEM_RID SID.
Sids::TerminalServer	Returns the SECURITY_TERMINAL_SERVER_RID SID.
Sids::Users	Returns the DOMAIN_ALIAS_RID_USERS SID.
Sids::World	Returns the SECURITY_WORLD_RID SID.
SystemTimeToHttpDate	Call this function to convert a system time to a string in a format suitable for using in HTTP headers.
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.

Share via

ATL Functions Alphabetical Reference

Additional resources