| title | IFileKey::GetPath Method |
|---|---|
| description | This article contains information about syntax, return value, and requirements for the IFileKey::GetPath method. |
| ms.date | 10/07/2016 |
| ms.assetid | c2b0cdbc-c41a-300b-3deb-8514b5069c3f |
Returns the absolute physical path of a file.
virtual PCWSTR GetPath(
VOID
) const = 0; This method takes no parameters.
A pointer to a constant null-terminated Unicode string that contains the absolute physical path of a file.
An example path is C:\InetPub\wwwroot\default.htm, which is the default Web page for the default Web site.
Values returned from the GetPath and IUriKey::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.
IFileKey implementers are responsible for memory management with this data; therefore, IFileKey implementers that use dynamic memory allocation must release or call delete on the PCWSTR pointer when it is no longer needed.
Implementers of the IFileKey interface may use the value returned from the GetPath method to implement both the IHttpCacheKey::GetIsEqual and IHttpCacheKey::GetIsPrefix methods.
IFileKey implementers are responsible for memory management with this data; therefore, IFileKey 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, because 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 IFileKey pointer and if the value returned from the GetPath method on both the current and pCacheCompareKey``IFileKey pointers returns equivalent PCWSTR strings.
The IHttpCacheKey::GetIsPrefix method returns true only if the pCacheCompareKey parameter can be cast to an IFileKey pointer and if the value returned from GetPath on the current IFileKey pointer is a substring of the value returned from GetPath on the pCacheCompareKey parameter, 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 GetPath 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-cppIFileKey#3]
The above code writes a new event to the Event Viewer, where the Data box contains a string similar to the following.
IFileKey::GetPath: C:\INETPUB\WWWROOT\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 |