Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The WinGate SDK comes with a section of helper functions and classes to make using the SDK simpler and less error prone. They are found under the helpers folder and currently consist of:

EventHelpers

The Events API provides and requires EventContextHandle objects to represent events. Event helpers provides the class EventContext that wraps the API functions inside member functions that are easier to use.

An EventContext object created with the default constructor will create a new EventContextHandle and destroy it when the EventContext is destroyed. An EventContext object created with a constructor that takes an EventContextHandle will reference the EventContextHandle and not destroy it when EventContext is destroyed. This allows you to take an EventContextHandle passed in from the Events API, wrap it in the convenience class EventContext that will modify the original.

NavItemHelpers

PersistHelpers

SchemaHelpers

StringHelpers

...

TypesHelpers

...

UUIDHelpers