Skip to content

ihttptokenentry-getsid-method.md

Latest commit

 

History

History
63 lines (45 loc) · 5.24 KB

ihttptokenentry-getsid-method.md

File metadata and controls

63 lines (45 loc) · 5.24 KB
title IHttpTokenEntry::GetSid Method
description Describes the IHttpTokenEntry::GetSid method and details its syntax, parameters, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid 4d08a669-2c55-4cbc-afc2-20e7dc15532d

IHttpTokenEntry::GetSid Method

Returns the security identifier for a user.

Syntax

virtual PSID GetSid(  
   VOID  
) = 0;

Parameters

This method takes no parameters.

Return Value

A pointer to a security identifier (SID).

Remarks

CGlobalModule derived classes that register for GL_CACHE_OPERATION events receive an ICacheProvider pointer as a parameter on the CGlobalModule::OnGlobalCacheOperationvirtual method. You can retrieve an IHttpCacheSpecificData pointer by calling the ICacheProvider::GetCacheRecord method and, in some cases, you can downcast this IHttpCacheSpecificData pointer to an IHttpTokenEntry pointer. You can then retrieve the security identifier by calling the GetSid method.

For more information on downcast rules, see ICacheProvider::GetCacheRecord.

Notes for Implementers

IHttpTokenEntry implementers are responsible for memory management with this data; therefore, IHttpTokenEntry implementers that use dynamic memory allocation must dispose of the PSID pointer when it is no longer needed.

Notes for Callers

IHttpTokenEntry implementers are responsible for memory management with this data; therefore, IHttpTokenEntry clients must not dispose of the returned PSID pointer when this data is no longer needed. Furthermore, clients must not change the state of the memory that this PSID references, because an access violation will be thrown or the data will become invalid.

Example

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 IHttpTokenEntry 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-cppIHttpTokenEntry#4]

The above code writes a new event to the Event Viewer, where the Data box contains a string similar to the following.

IHttpTokenEntry::GetSid: valid

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.

Requirements

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 Httpserv.h

See Also

IHttpTokenEntry Interface