Page tree
Skip to end of metadata
Go to start of metadata

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 latter option 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

NavItemHelpers provides a set of functions for conveniently creating Help, Task, Navigation and Message bar items in your UI side component.

PersistHelpers

PersistHelpers provide a set of functions for accessing the persistence store in a more convenient manner. It can:

  • Read and write fundamental types not supported by the standard Persistence API
  • Iterate a collection of sub nodes
  • Automatically open and close persistence nodes via PersistAutoHandle
  • Overwrite an entire subnode with an objects via its WriteConfig function

SchemaHelpers

StringHelpers

TypesHelpers

UUIDHelpers

  • No labels