mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-10-18 15:01:52 -05:00
Jordan Wages
735d7c4c91
Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle.
63 lines
1.6 KiB
Markdown
63 lines
1.6 KiB
Markdown
# Subscribe Method
|
||
|
||
|
||
Subscribes the specified event handler to the event with the given subscription level and origin.
|
||
|
||
|
||
|
||
## Definition
|
||
**Namespace:** <a href="N_CapyKit">CapyKit</a>
|
||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d
|
||
|
||
**C#**
|
||
``` C#
|
||
public static void Subscribe(
|
||
CapyEventHandler callback,
|
||
EventLevel subscriptionLevel,
|
||
string origin = null
|
||
)
|
||
```
|
||
**VB**
|
||
``` VB
|
||
Public Shared Sub Subscribe (
|
||
callback As CapyEventHandler,
|
||
subscriptionLevel As EventLevel,
|
||
Optional origin As String = Nothing
|
||
)
|
||
```
|
||
**C++**
|
||
``` C++
|
||
public:
|
||
static void Subscribe(
|
||
CapyEventHandler^ callback,
|
||
EventLevel subscriptionLevel,
|
||
String^ origin = nullptr
|
||
)
|
||
```
|
||
**F#**
|
||
``` F#
|
||
static member Subscribe :
|
||
callback : CapyEventHandler *
|
||
subscriptionLevel : EventLevel *
|
||
?origin : string
|
||
(* Defaults:
|
||
let _origin = defaultArg origin null
|
||
*)
|
||
-> unit
|
||
```
|
||
|
||
|
||
|
||
#### Parameters
|
||
<dl><dt> <a href="T_CapyKit_CapyEventHandler">CapyEventHandler</a></dt><dd>The event handler to subscribe.</dd><dt> <a href="T_CapyKit_EventLevel">EventLevel</a></dt><dd>The severity level of the event to subscribe to.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a> (Optional)</dt><dd>(Optional) The name of the method or class where the subscription is made.</dd></dl>
|
||
|
||
## Remarks
|
||
If there is no existing list for the given subscription level, a new list is created and added to the dictionary.
|
||
|
||
## See Also
|
||
|
||
|
||
#### Reference
|
||
<a href="T_CapyKit_CapyEventReporter">CapyEventReporter Class</a>
|
||
<a href="N_CapyKit">CapyKit Namespace</a>
|