MSDN Documentation

Software Development Kit (SDK) Reference

SDK Reference

Welcome to the official documentation for the Microsoft Software Development Kit (SDK). This section provides comprehensive reference material for all the APIs, components, and tools available within the SDK.

Navigate the sidebar to explore different modules and their respective functionalities. Each section details classes, methods, properties, and their usage with examples.

Core APIs

The Core APIs form the foundation of the SDK, providing essential functionalities for application development.

CoreApplication Class

Manages the lifecycle and core services of an application.

Methods
  • Initialize(string configPath): Initializes the application with a given configuration.
  • Run(): Starts the main application loop.
  • Shutdown(): Terminates the application gracefully.

Logger Class

Provides logging capabilities for debugging and tracing.

Methods
  • LogInfo(string message): Logs an informational message.
  • LogError(string message, Exception ex = null): Logs an error message, optionally with an exception.
  • LogWarning(string message): Logs a warning message.

// Example usage of Logger
Logger.LogInfo("Application started successfully.");
try {
    // Some operation
} catch (Exception ex) {
    Logger.LogError("An error occurred during processing.", ex);
}

UI Framework

The UI Framework offers components and patterns for building user interfaces.

Button Control

A standard button control for user interaction.

Properties
  • Text (string): The text displayed on the button.
  • OnClick (EventHandler): The event handler for click events.

// Example usage of Button
const myButton = new Button();
myButton.Text = "Click Me";
myButton.OnClick = () => {
    alert("Button was clicked!");
};
// Add myButton to the UI

Data Access

Modules for interacting with various data sources.

DatabaseClient Class

Provides methods for connecting to and querying databases.

Methods
  • Connect(string connectionString): Establishes a connection to the database.
  • ExecuteNonQuery(string query): Executes a SQL command that does not return a result set.
  • ExecuteQuery(string query): Executes a SQL query and returns the result set.

Networking

Tools for network communication.

HttpClient Class

A class for sending HTTP requests.

Methods
  • GetAsync(string url): Sends an asynchronous GET request.
  • PostAsync(string url, HttpContent content): Sends an asynchronous POST request.

Security

APIs related to authentication, authorization, and encryption.

Utilities

Helper classes and functions for common tasks.