Logging.LogBeginOperation Method

Article
12/13/2013

Applies To: Windows 8.1

Logs a Begin event to the AXE engine’s pre-configured ETW session.

Namespace: Microsoft.Assessments
Assembly: Microsoft.Assessments.Core (in Microsoft.Assessments.Core.dll)

Usage

'Usage
Dim instance As Logging
Dim operationId As UInteger
Dim message As String
Dim blob As Byte()

instance.LogBeginOperation(operationId, message, blob)

Syntax

'Declaration
Public Sub LogBeginOperation ( _
    operationId As UInteger, _
    message As String, _
    blob As Byte() _
)

public void LogBeginOperation (
    uint operationId,
    string message,
    byte[] blob
)

public:
void LogBeginOperation (
    unsigned int operationId, 
    String^ message, 
    array<unsigned char>^ blob
)

public void LogBeginOperation (
    UInt32 operationId, 
    String message, 
    byte[] blob
)

public function LogBeginOperation (
    operationId : uint, 
    message : String, 
    blob : byte[]
)

Parameters

operationId
A custom numerical identifier that identifies an operation expressed by the assessment.

message
A UNICODE string to log with the begin operation event. This string may be empty. This string must not be longer than 1024 characters.

blob
A custom byte stream to log to the ETW session.

Remarks

Calling this API logs the operationId, message and the blob to AXE’s ETW pre-configured session as the session’s LogBeginOperation event. Assessments should end the session with a call to LogEndOperation.

We strongly recommended that you log the Begin and End operation events as pairs matched by ID. If they are not matched, ETW trace processing tools and data viewers will not be able to analyze paired events.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows 8.1