| title | IUriKey::GetUrl Method |
|---|---|
| description | IUriKey::GetUrl Method returns the URL associated with the Uniform Resource Identifier (URI) data. |
| ms.date | 10/07/2016 |
| ms.assetid | e3bc1574-276e-faeb-b018-4bac8eadd66f |
Returns the URL associated with the Uniform Resource Identifier (URI) data.
virtual PCWSTR GetUrl(
VOID
) const = 0; This method takes no parameters.
A pointer to a constant null-terminated Unicode string that contains the URL.
An example of a URL for the default Web page on the default Web site is /Default.htm.
Values returned from the IFileKey::GetPath and GetUrl methods are often related; the former represents the absolute path of a file on a computer, while the latter represents the relative value on a Web server.
IUriKey implementers are responsible for memory management with this data; therefore, IUriKey implementers that use dynamic memory allocation must release or call delete on the PCWSTR pointer when it is no longer needed.
Implementers of the IUriKey interface may use the values returned from both the GetSiteId and GetUrl methods to implement the IHttpCacheKey::GetIsEqual method.
IUriKey implementers are responsible for memory management with this data; therefore, IUriKey clients must not release or call delete on the returned PCWSTR pointer when this data is no longer needed. Furthermore, clients must not cast this data to a pointer that is not a const or change the state of the memory referenced by this PCWSTR; otherwise, an access violation will be thrown or the data will become invalid.
The IHttpCacheKey::GetIsEqual method returns true only if the pCacheCompareKey parameter can be cast to an IUriKey pointer, and the values returned from both the GetSiteId and GetUrl methods return equivalent values on both the current IUriKey and pCacheCompareKey pointers.
The IHttpCacheKey::GetIsPrefix method returns false immediately if the GetSiteId value of the current IUriKey pointer is not the same as the value returned from the same method on the pCacheCompareKey parameter. Otherwise, GetIsPrefix returns true only if the GetUrl method on the current IUriKey pointer returns a PCWSTR that is a substring of the PCWSTR returned from the same method on the pCacheCompareKey pointer, starting at index 0.
The following code example demonstrates how to create a global module that listens for GL_CACHE_OPERATION and GL_CACHE_CLEANUP events and then writes the GetUrl information to the Event Viewer.
Caution
[!INCLUDEiisver] generates a large number of events in the Event Viewer. To avoid a log overflow error in a production environment, you should generally avoid writing cache information to the event log. For demonstration purposes, this code example writes an entry to the Event Viewer in debug mode only.
[!code-cppIUriKey#5]
The above code writes a new event to the Event Viewer, where the Data box contains a string that is similar to the following.
IUriKey::GetUrl: /DEFAULT.HTM
Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.
You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.
| Type | Description |
|---|---|
| Client | - IIS 7.0 on [!INCLUDEwinvista] - IIS 7.5 on Windows 7 - IIS 8.0 on Windows 8 - IIS 10.0 on Windows 10 |
| Server | - IIS 7.0 on [!INCLUDEwinsrv2008] - IIS 7.5 on Windows Server 2008 R2 - IIS 8.0 on Windows Server 2012 - IIS 8.5 on Windows Server 2012 R2 - IIS 10.0 on Windows Server 2016 |
| Product | - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 - [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100] |
| Header | Httpcach.h |