TraceLoggingProviderEnabled 함수(traceloggingprovider.h)
추적 소비자가 이 공급자의 이벤트를 수신 대기하는지 여부를 확인하는 추적 로깅 매크로입니다.
구문
TLG_PFORCEINLINE BOOLEAN TraceLoggingProviderEnabled(
TraceLoggingHProvider hProvider,
UCHAR eventLevel,
ULONGLONG eventKeyword
);
매개 변수
hProvider
검사 추적 로깅 공급자에 대한 핸들입니다.
eventLevel
검사 이벤트 수준입니다. 이벤트 수준 0은 이벤트를 나타냅니다.
eventKeyword
검사 키워드(keyword). 키워드(keyword) 0은 특정 키워드를 나타내지 않습니다.
반환 값
추적 소비자 세션이 지정된 조건과 일치하는 이벤트를 수신 대기 하는 경우 TRUE를 반환하고, 그렇지 않으면 FALSE 를 반환합니다.
설명
이 API는 이벤트를 사용할 수 있는지 여부를 확인하는 간단한 방법을 제공합니다. 즉, 이벤트 소비자 세션이 지정된 수준 및 키워드(keyword) 지정된 공급자로부터 이벤트를 수신하는 데 관심이 있는지 여부를 확인합니다.
참고
이 API는 보수적인 빠른 테스트를 수행합니다. 이 API는 후속 심층 필터링으로 실제로 이벤트를 기록할 필요가 없는 세션이 결정되는 특정 경우에 true를 반환할 수 있습니다.
대부분의 이벤트 공급자는 TraceLoggingProviderEnabled를 직접 호출하지 않습니다. TraceLoggingWrite 매크로는 자체 TraceLoggingProviderEnabled 테스트를 수행하고 이벤트가 사용하도록 설정되지 않은 경우 즉시 반환합니다. 그러나 TraceLoggingWrite 매크로를 호출하기 전에 복잡한 준비를 수행하기 전에 공급자가 TraceLoggingProviderEnabled를 호출하는 것이 유용할 수 있습니다.
예제
// Skip GetMyInformation() if nobody is listening for MyInformationEvent:
if (TraceLoggingProviderEnabled(MyProvider, MyEventLevel, MyEventKeyword))
{
MY_INFORMATION info;
GetMyInformation(&info);
TraceLoggingWrite(
MyProvider,
"MyInformationEvent",
TraceLoggingLevel(MyEventLevel),
TraceLoggingKeyword(MyEventKeyword),
TraceLoggingValue(info.Val1),
TraceLoggingValue(info.Val2));
}
요구 사항
요구 사항 | 값 |
---|---|
지원되는 최소 클라이언트 | Windows Vista [데스크톱 앱 | UWP 앱] |
지원되는 최소 서버 | Windows Server 2008 [데스크톱 앱 | UWP 앱] |
머리글 | traceloggingprovider.h |