URL Monikers and Asynchronous Pluggable Protocol Reference
This section contains reference information for URL Monikers and Asynchronous Pluggable Protocol.
In this section
| Topic | Description |
|---|---|
Lists the pre-defined protocols for asynchronous pluggable protocols. |
|
Lists the interfaces for URL Monikers. |
|
This section lists the functions for URL Monikers. |
|
This section contains a list of structures available for URL Monikers. |
|
This section lists the enumerations for URL Monikers. |
|
This section contains a list of constants available for URL Monikers. |
Constants
| Topic | Contents |
|---|---|
| Clipboard Formats | This topic describes clipboard format types and the MIME type strings that identify them. |
| Install Scopes | Install Scope bit flag values. |
| URL Moniker Error Codes | This topic lists the error codes exposed by URL monikers. The list is sorted alphabetically by name. |
Functions
| Topic | Contents |
|---|---|
| AsyncInstallDistributionUnit | Installs the specified component. |
| CoGetClassObjectFromURL | Returns a factory object for a given CLSID. |
| CoInternetCombineIUri | Combines a base Uniform Resource Identifier (URI) and a relative URI into a full URI. |
| CoInternetCombineUrl | Combines a base URL and a relative URL into a full URL. |
| CoInternetCombineUrlEx | Combines a base URL and a relative URL into a full URI. |
| CoInternetCompareUrl | Compares two URLs and determines if they are equal. |
| CoInternetParseIUri | Transforms and identifies parts of URLs. Compare to CoInternetParseUrl. |
| CoInternetParseUrl | Transforms and identifies parts of URLs. Compare to CoInternetParseIUri. |
| CoInternetQueryInfo | Retrieves information related to the specified URL. |
| CompareSecurityIds | Compares two security identifiers (SIDs) for equivalence. |
| CompatFlagsFromClsid | Reads the Microsoft ActiveX Compatibility registry entries for the specified ActiveX control. |
| CopyBindInfo | Copies the given BINDINFO structure. |
| CopyStgMedium | Copies the given STGMEDIUM structure. |
| CreateAsyncBindCtx | Creates an asynchronous bind context for use with asynchronous monikers. |
| CreateAsyncBindCtxEx | Creates an asynchronous bind context for use with asynchronous monikers. |
| CreateFormatEnumerator | Creates an object that implements IEnumFORMATETC over a static array of FORMATETC structures. |
| CreateIUriBuilder | Creates a new IUriBuilder instance, and initializes it from an optional IUri. |
| CreateUri | Creates a new IUri instance, and initializes it from a URI string. CreateUri also normalizes and validates the URI. |
| CreateUriFromMultiByteString | Converts an ANSI URL with components in various multibyte character set (MBCS) encodings to an IUri object. |
| CreateUriWithFragment | Creates a new IUri instance (and optional fragment), and initializes the instance from a URI string. |
| CreateURLBinding | Not implemented. |
| CreateURLMoniker | Deprecated in Windows Internet Explorer 7. Use CreateURLMonikerEx instead. |
| CreateURLMonikerEx | Creates a URL moniker from a full URL, or from a base context URL moniker and a partial URL. |
| CreateURLMonikerEx2 | Creates a new URL moniker from a full URI, or from a base context URL moniker and a relative URI. |
| FaultInIEFeature | This synchronous function is invoked by the client of a Windows Internet Explorer feature before the client accesses the feature. |
| FindMediaType | Retrieves the 32-bit value assigned to the specified media type. |
| FindMediaTypeClass | Retrieves the CLSID for the specified media type. |
| FindMimeFromData | Determines the MIME type from the data provided. |
| GetClassFileOrMime | Gets the CLSID of the object to instantiate for the specified file. |
| GetClassURL | Not implemented. |
| GetComponentIDFromCLSSPEC | Gets a string component ID from information contained in a union |
| IEInstallScope | This function provides the current Install Scope to a ActiveX DLL. |
| IsAsyncMoniker | Tests to determine whether a moniker supports asynchronous binding. |
| IsValidURL | Determines if a specified string is a valid URL. |
| MkParseDisplayNameEx | Creates a moniker to the object that is specified by the given string. |
| ObtainUserAgentString | Retrieves the User-Agent HTTP request header string that is currently being used. |
| RegisterBindStatusCallback | Registers a callback interface with an existing bind context. |
| RegisterFormatEnumerator | Registers a FORMATETC enumerator object on the given bind context. |
| RegisterMediaTypeClass | Registers a mapping of media types to CLSIDs to override the default mapping specified in the registry. |
| RegisterMediaTypes | Registers media type strings. |
| ReleaseBindInfo | Releases the resources used by the specified BINDINFO structure. |
| RevokeBindStatusCallback | Revokes a bind status callback interface previously registered on a bind context. |
| RevokeFormatEnumerator | Removes a format enumerator from the given bind context. |
| URLDownloadToCacheFile | Downloads data to the Internet cache and returns the file name of the cache location for retrieving the bits. |
| URLDownloadToFile | Downloads bits from the Internet and saves them to a file. |
| UrlMkGetSessionOption | Gets options for the current Internet session. |
| UrlMkSetSessionOption | Sets options for the current Internet session. |
| URLOpenBlockingStream | Creates a blocking type stream object from a URL and downloads the data from the Internet. When the data is downloaded, the client application or control can read it by using the IStream::Read method. |
| URLOpenPullStream | Creates a pull type stream object from a URL. |
| URLOpenStream | Creates a push type stream object from a URL. |
Predefined Protocols
| Topic | Contents |
|---|---|
| data Protocol | Specifies a data URI, which is a resource, typically an image, embedded in the URI as opposed to one loaded from an external URL. |
| file protocol | Opens a file on a local or network drive. |
| ftp Protocol | Opens a file transfer session with the specified site address. |
| gopher Protocol | Opens a gopher session with the specified site address. |
| http Protocol | Opens a hypertext transfer session with the specified site address. |
| https Protocol | Opens a secure hypertext transfer session with the specified site address. |
| javascript Protocol | Specifies that the URL is JavaScript code. |
| mailto Protocol | Opens a client's e-mail system and begins a new email message. |
| news Protocol | Opens a newsgroup in the client's default news application. |
| res Protocol | Specifies a resource that will be obtained from a module. |
| telnet_Protocol | Opens a terminal login session with the default Telnet client. |
| view-source Protocol | Obsolete for Microsoft Internet Explorer 6 for Windows XP Service Pack 2 (SP2) and later. For earlier versions, opens a Web page in the client's default HTML editor. |
Note Some of these protocols are no longer supported by Internet Explorer.
Interfaces
| Topic | Contents |
|---|---|
| IAuthenticate | Provides the URL moniker with information to authenticate the user. |
| IAuthenticateEx | Provides the URL moniker with information to authenticate the user. |
| IBindHost | Provides methods that enable controls to perform asynchronous data transfers through the ActiveX container. |
| IBinding | Provides methods that enable the client program that is using an asynchronous moniker to control the progress of the bind operation. |
| IBindProtocol | Not supported. |
| IBindStatusCallback | Accepts information on an asynchronous bind operation. |
| IBindStatusCallbackEx | Implements the notification object for an asynchronous bind operation. |
| ICatalogFileInfo | Provides methods to obtain catalog information. |
| ICodeInstall | Provides a method for problems with application installations or file downloads. |
| IHttpNegotiate | Implemented by a client application to provide support for HTTP negotiations. |
| IHttpNegotiate2 | Implemented by a client application to provide support for HTTP negotiations; extends the IHttpNegotiate interface. |
| IHttpNegotiate3 | Extends the IHttpNegotiate interface with support for client certificates. |
| IHttpSecurity | Notifies a client application of authentication problems. |
| IMonikerProp | Provides access to the properties of a moniker. |
| IPersistMoniker | Provides methods that offer more control over the binding of persistent data. |
| ISoftDistExt | Provides methods that are used by Software Update Channels, which is a specialized version of Active Channels, to register and install software distribution units. |
| IUri | Exposes methods and properties used to parse and build URIs in Internet Explorer 7. |
| IUriBuilder | Exposes methods used to create a new IUri from an existing one. |
| IUriBuilderFactory | Exposes methods to instantiate and initialize an IUriBuilder object. |
| IUriContainer | Exposes a method that returns an encapsulated IUri interface. |
| IWindowForBindingUI | Enables clients of URL monikers to display information in the client's user interface, when necessary. |
| IWinInetCacheAccess | Provides access to Temporary Internet Files (TIF) folder files (Windows CE only). |
| IWinInetCacheHints | Enables an URLMON client to change the file name extension on the Microsoft Win32 Internet (WinInet) cache file. |
| IWinInetCacheHints2 | Extends the IWinInetCacheHints interface using a WCHAR version of the IWinInetCacheHints::SetCacheExtension method. |
| IWinInetFileStream | Implements methods to manage the lifetime of objects in the Internet file cache. |
| IWinInetHttpInfo | Checks information on HTTP requests that are made through the underlying Microsoft Win32 Internet functions. |
| IWinInetInfo | Gets option information that is used by the underlying Win32 Internet functions. |
Methods
| Topic | Contents |
|---|---|
| Abort | Ends the bind operation. |
| AsyncInstallDistributionUnit | Asynchronously installs the software distribution unit. |
| Authenticate | Supplies authentication support to a URL moniker from a client application. |
| IAuthenticateEx::AuthenticateEx | Supplies authentication support to a URL moniker from a client application. |
| BeginningTransaction | Notifies the client of the URL that is being bound to at the beginning of an HTTP transaction. |
| CreateInitializedIUriBuilder | Returns an IUriBuilder that can operate on this object and initializes it with the current IUri. |
| CreateIUriBuilder | Returns an IUriBuilder that can operate on this object, but which contains no IUri. |
| CreateMoniker | Creates a moniker to bind to a URL. |
| CreateUri | Returns a new IUri object based on modifications to the original IUri. |
| CreateUriSimple | Returns a new IUri object based on modifications to the original IUri, using the original |
| CreateUriWithFlags | Returns a new IUri object based on modifications to the original IUri. |
| GetAbsoluteUri | Returns the entire canonicalized URI. |
| GetAuthority | Returns the user name, password, domain, and port. |
| GetBindInfo | Provides information about how the bind operation is handled when it is called by an asynchronous moniker. |
| GetBindInfoEx | Provides information about how the bind operation is handled when called by an asynchronous moniker. |
| GetBindResult | Gets the protocol-specific outcome of a bind operation. |
| GetCatalogFile | Returns the catalog file. |
| GetClassID | Gets the class identifier of an object. |
| GetCurMoniker | Gets the moniker that refers to the object's persistent state. |
| GetDisplayUri | Returns a URI that can be used for display purposes. |
| GetDomain | Returns the domain name (including top-level domain) only. |
| GetExtension | Returns the file name extension of the resource. |
| GetFirstCodeBase | Returns the first codebase URL from the specified software distribution unit. |
| GetFragment | Returns the text following a fragment marker (#), including the fragment marker itself. |
| GetFragment | Retrieves the value of the fragment component. |
| GetHost | Returns the fully qualified domain name. |
| GetHost | Retrieves the value of the host component. |
| GetHostType | Returns a value from the Uri_HOST_TYPE enumeration. |
| GetIUri | Returns the original IUri. |
| GetIUri | Returns the IUri contained by the IUriContainer. |
| GetJavaTrust | Returns the Java permissions. |
| GetNextCodeBase | Returns the next codebase URL from the specified software distribution unit. |
| GetPassword | Returns the password, as parsed from the URI. |
| GetPassword | Retrieves the value of the password component. |
| GetPath | Returns the path and resource name. |
| GetPath | Retrieves the value of the path component. |
| GetPathAndQuery | Returns the path, resource name, and query string. |
| GetPort | Returns the port number. |
| GetPort | Retrieves the value of the port component. |
| GetPriority | Gets the priority of the bind operation. |
| GetPriority | Gets the priority for the bind operation when it is called by an asynchronous moniker. |
| GetProperties | Returns a bitmap of flags that indicate which URI properties have been set. |
| GetPropertyBSTR | Returns the specified URI property value in a new BSTR. |
| GetPropertyDWORD | Returns the specified numeric URI property value. |
| GetPropertyLength | Returns the string length of the specified URI property. Call this function if you want the length but don't necessarily want to create a new BSTR. |
| GetQuery | Returns the query string. |
| GetQuery | Retrieves the value of the query component. |
| GetRawUri | Returns the entire original URI input string. |
| GetRootSecurityId | Gets a root security ID. |
| GetScheme | Returns a value from the URL_SCHEME enumeration. |
| GetSchemeName | Returns the protocol scheme name. |
| GetSchemeName | Retrieves the value of the protocol scheme name. |
| GetSerializedClientCertContext | Gets a serialized client security context. |
| GetUserInfo | Returns the user name and password, as parsed from the URI. |
| GetUserName | Returns the user name as parsed from the URI. |
| GetUserName | Retrieves the value of the username component. |
| GetWindow | Gets a handle to a window to present information in the user interface during a bind operation. |
| GetZone | Not implemented. |
| HasBeenModified | Returns TRUE if component values have been modified. |
| HasProperty | Determines if the specified property exists in the URI. |
| IsDirty | Checks an object for changes since it was last saved. |
| IsEqual | Compares the logical content of two IUri objects. |
| Load | Loads the object from its persistent state as indicated by a supplied moniker. |
| MonikerBindToObject | Binds a moniker to an object. |
| MonikerBindToStorage | Binds a moniker to storage. |
| OnCodeInstallProblem | Returns a value based on the status passed in, which indicates whether to abort the application installation or file download. |
| OnDataAvailable | Provides data to the client as it becomes available during asynchronous bind operations. |
| OnLowResource | Not implemented. |
| OnObjectAvailable | Passes the requested object interface pointer to the client. |
| OnProgress | Indicates the progress of the bind operation. |
| OnResponse | Enables the client of a bind operation to examine the response headers, optionally terminate the bind operation, and add HTTP headers to a request before resending the request. |
| OnSecurityProblem | Notifies the client application about an authentication problem. |
| OnStartBinding | Notifies the client about the callback methods that it is registered to receive. This notification is a response to the flags the client requested in the RegisterBindStatusCallback function. |
| OnStopBinding | Indicates the end of the bind operation. |
| PreventCacheEntryWrite | Not implemented. |
| ProcessSoftDist | Processes a software distribution unit from the specified Software Update Channel URL. |
| PutProperty | Sets the value of a property on a moniker. |
| QueryInfo | Gets the specified information from an HTTP request. |
| QueryOption | Gets the specified Win32 Internet function option. |
| RemoveProperties | Removes the specified properties as well as any derived properties. |
| Resume | Resumes the bind operation. |
| Save | Tells the object to save itself to a specified location. |
| SaveCompleted | Notifies the client application that its persisted state has been completely saved, and points the client to its new persisted state. |
| SetCacheExtension | Changes the file name extension on the WinInet cache file to the specified extension. |
| SetCacheExtension2 | Changes the file name extension on the WinInet cache file to the specified extension. |
| SetCacheFilename | Invokes InternetSetOption to change the name and path of the cache file. |
| SetDeleteFile | Indicates that the cache entry is to be deleted when the object is destroyed. |
| SetFragment | Sets the fragment component. |
| SetHandleForUnlock | Sets a file handle to unlock when the object is released. |
| SetHost | Sets the host (fully qualify domain) component. |
| SetIUri | Sets the current IUri. |
| SetPassword | Sets the password component. |
| SetPath | Sets the path component. |
| SetPort | Sets the port component. |
| SetPriority | Sets the priority of the bind operation. |
| SetQuery | Sets the query component. |
| SetSchemeName | Sets the protocol scheme name. |
| SetUserName | Sets the username component. |
| Suspend | Suspends the bind operation. |
Enumerations
| Topic | Contents |
|---|---|
| AUTHENTICATEF | Flags used by the IAuthenticateEx::AuthenticateEx method to pass information about the authentication request. |
| BINDF | Contains the values that determine how a resource is bound to a moniker. |
| BINDF2 | Defines flags that specify how a resource is bound to a moniker. This type extends the BINDF enumerated type. |
| BINDINFO_OPTIONS | Contains the option flags used in the BINDINFO structure. |
| BINDINFOF | Contains values that determine the use of URL encoding during the binding operation. |
| BINDSTATUS | Contains values that are passed to the client application's implementation of the IBindStatusCallback::OnProgress method. These values indicate the progress of the bind operation. |
| BINDVERB | Contains values that specify an action, such as an HTTP request, to be performed during the binding operation. |
| BSCF | Values from the BSCF enumeration are passed to the client in IBindStatusCallback::OnDataAvailable to indicate the type of data that is available. |
| CIP_STATUS | Contains the various application installation or file download problem statuses. |
| MONIKERPROPERTY | Contains values that identify properties of a moniker. |
| PARSEACTION | Contains options for URL parsing operations. Used by CoInternetParseUrl, CoInternetParseIUri, and implementations of IInternetProtocolInfo::ParseUrl. |
| QUERYOPTION | Contains the available query options for CoInternetQueryInfo. |
| Uri_HOST_TYPE | Describes the format of the specified host in a URI. |
| Uri_PROPERTY | Represents properties that an IUri can contain. The properties in the range Uri_PROPERTY_STRING_START to Uri_PROPERTY_STRING_LAST are strings and the rest are DWORD values. |
| URL_ENCODING | Contains the flags that control the encoding of URLs. |
Structures
| Topic | Contents |
|---|---|
| AUTHENTICATEINFO | Contains additional information on the authentication operation. |
| BINDINFO | Contains additional information on the requested binding operation. The meaning of this structure is specific to the type of asynchronous moniker. |
| CODEBASEHOLD | Contains codebase values. |
| CONFIRMSAFETY | Contains a class identifier (CLSID) and pointer to an object. |
| JAVA_TRUST | Contains Java permission information. |