evtbookmark

Documentation

Overview

Package evtbookmark provides helpers for working with Windows Event Log Bookmarks

Index

• type Bookmark
  • func New(options ...Option) (Bookmark, error)
• type Option
  • func FromFile(bookmarkPath string) Option
  • func FromXML(bookmarkXML string) Option
  • func WithWindowsEventLogAPI(api evtapi.API) Option

Types

type Bookmark

type Bookmark interface {
	Handle() evtapi.EventBookmarkHandle
	Update(evtapi.EventRecordHandle) error
	Render() (string, error)
	Close()
}

Bookmark is an interface for handling Windows Event Log Bookmarks https://learn.microsoft.com/en-us/windows/win32/wes/bookmarking-events

func New

func New(options ...Option) (Bookmark, error)

New constructs a new Bookmark. Call Close() when done to release resources.

type Option

type Option func(*bookmark) error

Option type for option pattern for New bookmark constructor

func FromFile

func FromFile(bookmarkPath string) Option

FromFile loads a rendered bookmark from a file path

func FromXML

func FromXML(bookmarkXML string) Option

FromXML loads a rendered bookmark

func WithWindowsEventLogAPI

func WithWindowsEventLogAPI(api evtapi.API) Option

WithWindowsEventLogAPI sets the API implementation used by the bookmark