* Annotate evntprov.h.

svn path=/trunk/; revision=58475
This commit is contained in:
Amine Khaldi 2013-03-12 11:40:11 +00:00
parent 447b3b8db9
commit 8fc7b3332f

View file

@ -90,72 +90,72 @@ typedef struct _EVENT_FILTER_HEADER {
typedef VOID typedef VOID
(NTAPI *PENABLECALLBACK)( (NTAPI *PENABLECALLBACK)(
IN LPCGUID SourceId, _In_ LPCGUID SourceId,
IN ULONG IsEnabled, _In_ ULONG IsEnabled,
IN UCHAR Level, _In_ UCHAR Level,
IN ULONGLONG MatchAnyKeyword, _In_ ULONGLONG MatchAnyKeyword,
IN ULONGLONG MatchAllKeyword, _In_ ULONGLONG MatchAllKeyword,
IN PEVENT_FILTER_DESCRIPTOR FilterData OPTIONAL, _In_opt_ PEVENT_FILTER_DESCRIPTOR FilterData,
IN OUT PVOID CallbackContext OPTIONAL); _Inout_opt_ PVOID CallbackContext);
#if (WINVER >= _WIN32_WINNT_VISTA) #if (WINVER >= _WIN32_WINNT_VISTA)
ULONG ULONG
EVNTAPI EVNTAPI
EventRegister( EventRegister(
IN LPCGUID ProviderId, _In_ LPCGUID ProviderId,
IN PENABLECALLBACK EnableCallback OPTIONAL, _In_opt_ PENABLECALLBACK EnableCallback,
IN PVOID CallbackContext OPTIONAL, _In_opt_ PVOID CallbackContext,
OUT PREGHANDLE RegHandle); _Out_ PREGHANDLE RegHandle);
ULONG ULONG
EVNTAPI EVNTAPI
EventUnregister( EventUnregister(
IN REGHANDLE RegHandle); _In_ REGHANDLE RegHandle);
BOOLEAN BOOLEAN
EVNTAPI EVNTAPI
EventEnabled( EventEnabled(
IN REGHANDLE RegHandle, _In_ REGHANDLE RegHandle,
IN PCEVENT_DESCRIPTOR EventDescriptor); _In_ PCEVENT_DESCRIPTOR EventDescriptor);
BOOLEAN BOOLEAN
EVNTAPI EVNTAPI
EventProviderEnabled( EventProviderEnabled(
IN REGHANDLE RegHandle, _In_ REGHANDLE RegHandle,
IN UCHAR Level, _In_ UCHAR Level,
IN ULONGLONG Keyword); _In_ ULONGLONG Keyword);
ULONG ULONG
EVNTAPI EVNTAPI
EventWrite( EventWrite(
IN REGHANDLE RegHandle, _In_ REGHANDLE RegHandle,
IN PCEVENT_DESCRIPTOR EventDescriptor, _In_ PCEVENT_DESCRIPTOR EventDescriptor,
IN ULONG UserDataCount, _In_ ULONG UserDataCount,
IN PEVENT_DATA_DESCRIPTOR UserData); _In_reads_opt_(UserDataCount) PEVENT_DATA_DESCRIPTOR UserData);
ULONG ULONG
EVNTAPI EVNTAPI
EventWriteTransfer( EventWriteTransfer(
IN REGHANDLE RegHandle, _In_ REGHANDLE RegHandle,
IN PCEVENT_DESCRIPTOR EventDescriptor, _In_ PCEVENT_DESCRIPTOR EventDescriptor,
IN LPCGUID ActivityId OPTIONAL, _In_opt_ LPCGUID ActivityId,
IN LPCGUID RelatedActivityId OPTIONAL, _In_opt_ LPCGUID RelatedActivityId,
IN ULONG UserDataCount, _In_ ULONG UserDataCount,
IN PEVENT_DATA_DESCRIPTOR UserData OPTIONAL); _In_reads_opt_(UserDataCount) PEVENT_DATA_DESCRIPTOR UserData);
ULONG ULONG
EVNTAPI EVNTAPI
EventWriteString( EventWriteString(
IN REGHANDLE RegHandle, _In_ REGHANDLE RegHandle,
IN UCHAR Level, _In_ UCHAR Level,
IN ULONGLONG Keyword, _In_ ULONGLONG Keyword,
IN PCWSTR String); _In_ PCWSTR String);
ULONG ULONG
EVNTAPI EVNTAPI
EventActivityIdControl( EventActivityIdControl(
IN ULONG ControlCode, _In_ ULONG ControlCode,
IN OUT LPGUID ActivityId); _Inout_ LPGUID ActivityId);
#endif /* (WINVER >= _WIN32_WINNT_VISTA) */ #endif /* (WINVER >= _WIN32_WINNT_VISTA) */
@ -163,14 +163,14 @@ EventActivityIdControl(
ULONG ULONG
EVNTAPI EVNTAPI
EventWriteEx( EventWriteEx(
IN REGHANDLE RegHandle, _In_ REGHANDLE RegHandle,
IN PCEVENT_DESCRIPTOR EventDescriptor, _In_ PCEVENT_DESCRIPTOR EventDescriptor,
IN ULONG64 Filter, _In_ ULONG64 Filter,
IN ULONG Flags, _In_ ULONG Flags,
IN LPCGUID ActivityId OPTIONAL, _In_opt_ LPCGUID ActivityId,
IN LPCGUID RelatedActivityId OPTIONAL, _In_opt_ LPCGUID RelatedActivityId,
IN ULONG UserDataCount, _In_ ULONG UserDataCount,
IN PEVENT_DATA_DESCRIPTOR UserData OPTIONAL); _In_reads_opt_(UserDataCount) PEVENT_DATA_DESCRIPTOR UserData);
#endif #endif
#endif // _ETW_KM_ #endif // _ETW_KM_
@ -178,9 +178,9 @@ EventWriteEx(
FORCEINLINE FORCEINLINE
VOID VOID
EventDataDescCreate( EventDataDescCreate(
OUT PEVENT_DATA_DESCRIPTOR EventDataDescriptor, _Out_ PEVENT_DATA_DESCRIPTOR EventDataDescriptor,
IN const VOID* DataPtr, _In_reads_bytes_(DataSize) const VOID* DataPtr,
IN ULONG DataSize) _In_ ULONG DataSize)
{ {
EventDataDescriptor->Ptr = (ULONGLONG)(ULONG_PTR)DataPtr; EventDataDescriptor->Ptr = (ULONGLONG)(ULONG_PTR)DataPtr;
EventDataDescriptor->Size = DataSize; EventDataDescriptor->Size = DataSize;
@ -190,14 +190,14 @@ EventDataDescCreate(
FORCEINLINE FORCEINLINE
VOID VOID
EventDescCreate( EventDescCreate(
OUT PEVENT_DESCRIPTOR EventDescriptor, _Out_ PEVENT_DESCRIPTOR EventDescriptor,
IN USHORT Id, _In_ USHORT Id,
IN UCHAR Version, _In_ UCHAR Version,
IN UCHAR Channel, _In_ UCHAR Channel,
IN UCHAR Level, _In_ UCHAR Level,
IN USHORT Task, _In_ USHORT Task,
IN UCHAR Opcode, _In_ UCHAR Opcode,
IN ULONGLONG Keyword) _In_ ULONGLONG Keyword)
{ {
EventDescriptor->Id = Id; EventDescriptor->Id = Id;
EventDescriptor->Version = Version; EventDescriptor->Version = Version;
@ -211,7 +211,7 @@ EventDescCreate(
FORCEINLINE FORCEINLINE
VOID VOID
EventDescZero( EventDescZero(
OUT PEVENT_DESCRIPTOR EventDescriptor) _Out_ PEVENT_DESCRIPTOR EventDescriptor)
{ {
memset(EventDescriptor, 0, sizeof(EVENT_DESCRIPTOR)); memset(EventDescriptor, 0, sizeof(EVENT_DESCRIPTOR));
} }
@ -219,7 +219,7 @@ EventDescZero(
FORCEINLINE FORCEINLINE
USHORT USHORT
EventDescGetId( EventDescGetId(
IN PCEVENT_DESCRIPTOR EventDescriptor) _In_ PCEVENT_DESCRIPTOR EventDescriptor)
{ {
return (EventDescriptor->Id); return (EventDescriptor->Id);
} }
@ -227,7 +227,7 @@ EventDescGetId(
FORCEINLINE FORCEINLINE
UCHAR UCHAR
EventDescGetVersion( EventDescGetVersion(
IN PCEVENT_DESCRIPTOR EventDescriptor) _In_ PCEVENT_DESCRIPTOR EventDescriptor)
{ {
return (EventDescriptor->Version); return (EventDescriptor->Version);
} }
@ -235,7 +235,7 @@ EventDescGetVersion(
FORCEINLINE FORCEINLINE
USHORT USHORT
EventDescGetTask( EventDescGetTask(
IN PCEVENT_DESCRIPTOR EventDescriptor) _In_ PCEVENT_DESCRIPTOR EventDescriptor)
{ {
return (EventDescriptor->Task); return (EventDescriptor->Task);
} }
@ -243,7 +243,7 @@ EventDescGetTask(
FORCEINLINE FORCEINLINE
UCHAR UCHAR
EventDescGetOpcode( EventDescGetOpcode(
IN PCEVENT_DESCRIPTOR EventDescriptor) _In_ PCEVENT_DESCRIPTOR EventDescriptor)
{ {
return (EventDescriptor->Opcode); return (EventDescriptor->Opcode);
} }
@ -251,7 +251,7 @@ EventDescGetOpcode(
FORCEINLINE FORCEINLINE
UCHAR UCHAR
EventDescGetChannel( EventDescGetChannel(
IN PCEVENT_DESCRIPTOR EventDescriptor) _In_ PCEVENT_DESCRIPTOR EventDescriptor)
{ {
return (EventDescriptor->Channel); return (EventDescriptor->Channel);
} }
@ -259,7 +259,7 @@ EventDescGetChannel(
FORCEINLINE FORCEINLINE
UCHAR UCHAR
EventDescGetLevel( EventDescGetLevel(
IN PCEVENT_DESCRIPTOR EventDescriptor) _In_ PCEVENT_DESCRIPTOR EventDescriptor)
{ {
return (EventDescriptor->Level); return (EventDescriptor->Level);
} }
@ -267,7 +267,7 @@ EventDescGetLevel(
FORCEINLINE FORCEINLINE
ULONGLONG ULONGLONG
EventDescGetKeyword( EventDescGetKeyword(
IN PCEVENT_DESCRIPTOR EventDescriptor) _In_ PCEVENT_DESCRIPTOR EventDescriptor)
{ {
return (EventDescriptor->Keyword); return (EventDescriptor->Keyword);
} }
@ -275,8 +275,8 @@ EventDescGetKeyword(
FORCEINLINE FORCEINLINE
PEVENT_DESCRIPTOR PEVENT_DESCRIPTOR
EventDescSetId( EventDescSetId(
IN PEVENT_DESCRIPTOR EventDescriptor, _In_ PEVENT_DESCRIPTOR EventDescriptor,
IN USHORT Id) _In_ USHORT Id)
{ {
EventDescriptor->Id = Id; EventDescriptor->Id = Id;
return (EventDescriptor); return (EventDescriptor);
@ -285,8 +285,8 @@ EventDescSetId(
FORCEINLINE FORCEINLINE
PEVENT_DESCRIPTOR PEVENT_DESCRIPTOR
EventDescSetVersion( EventDescSetVersion(
IN PEVENT_DESCRIPTOR EventDescriptor, _In_ PEVENT_DESCRIPTOR EventDescriptor,
IN UCHAR Version) _In_ UCHAR Version)
{ {
EventDescriptor->Version = Version; EventDescriptor->Version = Version;
return (EventDescriptor); return (EventDescriptor);
@ -295,8 +295,8 @@ EventDescSetVersion(
FORCEINLINE FORCEINLINE
PEVENT_DESCRIPTOR PEVENT_DESCRIPTOR
EventDescSetTask( EventDescSetTask(
IN PEVENT_DESCRIPTOR EventDescriptor, _In_ PEVENT_DESCRIPTOR EventDescriptor,
IN USHORT Task) _In_ USHORT Task)
{ {
EventDescriptor->Task = Task; EventDescriptor->Task = Task;
return (EventDescriptor); return (EventDescriptor);
@ -305,8 +305,8 @@ EventDescSetTask(
FORCEINLINE FORCEINLINE
PEVENT_DESCRIPTOR PEVENT_DESCRIPTOR
EventDescSetOpcode( EventDescSetOpcode(
IN PEVENT_DESCRIPTOR EventDescriptor, _In_ PEVENT_DESCRIPTOR EventDescriptor,
IN UCHAR Opcode) _In_ UCHAR Opcode)
{ {
EventDescriptor->Opcode = Opcode; EventDescriptor->Opcode = Opcode;
return (EventDescriptor); return (EventDescriptor);
@ -315,8 +315,8 @@ EventDescSetOpcode(
FORCEINLINE FORCEINLINE
PEVENT_DESCRIPTOR PEVENT_DESCRIPTOR
EventDescSetLevel( EventDescSetLevel(
IN PEVENT_DESCRIPTOR EventDescriptor, _In_ PEVENT_DESCRIPTOR EventDescriptor,
IN UCHAR Level) _In_ UCHAR Level)
{ {
EventDescriptor->Level = Level; EventDescriptor->Level = Level;
return (EventDescriptor); return (EventDescriptor);
@ -325,8 +325,8 @@ EventDescSetLevel(
FORCEINLINE FORCEINLINE
PEVENT_DESCRIPTOR PEVENT_DESCRIPTOR
EventDescSetChannel( EventDescSetChannel(
IN PEVENT_DESCRIPTOR EventDescriptor, _In_ PEVENT_DESCRIPTOR EventDescriptor,
IN UCHAR Channel) _In_ UCHAR Channel)
{ {
EventDescriptor->Channel = Channel; EventDescriptor->Channel = Channel;
return (EventDescriptor); return (EventDescriptor);
@ -335,8 +335,8 @@ EventDescSetChannel(
FORCEINLINE FORCEINLINE
PEVENT_DESCRIPTOR PEVENT_DESCRIPTOR
EventDescSetKeyword( EventDescSetKeyword(
IN PEVENT_DESCRIPTOR EventDescriptor, _In_ PEVENT_DESCRIPTOR EventDescriptor,
IN ULONGLONG Keyword) _In_ ULONGLONG Keyword)
{ {
EventDescriptor->Keyword = Keyword; EventDescriptor->Keyword = Keyword;
return (EventDescriptor); return (EventDescriptor);
@ -346,8 +346,8 @@ EventDescSetKeyword(
FORCEINLINE FORCEINLINE
PEVENT_DESCRIPTOR PEVENT_DESCRIPTOR
EventDescOrKeyword( EventDescOrKeyword(
IN PEVENT_DESCRIPTOR EventDescriptor, _In_ PEVENT_DESCRIPTOR EventDescriptor,
IN ULONGLONG Keyword) _In_ ULONGLONG Keyword)
{ {
EventDescriptor->Keyword |= Keyword; EventDescriptor->Keyword |= Keyword;
return (EventDescriptor); return (EventDescriptor);
@ -356,4 +356,3 @@ EventDescOrKeyword(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif