winpty.h File Reference

#include <windows.h>
#include "winpty_constants.h"

Include dependency graph for winpty.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	WINPTY_API   __declspec(dllimport)

Typedefs
typedef struct winpty_error_s	winpty_error_t
typedef winpty_error_t *	winpty_error_ptr_t
typedef DWORD	winpty_result_t
typedef struct winpty_config_s	winpty_config_t
typedef struct winpty_s	winpty_t
typedef struct winpty_spawn_config_s	winpty_spawn_config_t

Functions
WINPTY_API winpty_result_t	winpty_error_code (winpty_error_ptr_t err)
WINPTY_API LPCWSTR	winpty_error_msg (winpty_error_ptr_t err)
WINPTY_API void	winpty_error_free (winpty_error_ptr_t err)
WINPTY_API winpty_config_t *	winpty_config_new (UINT64 agentFlags, winpty_error_ptr_t *err)
WINPTY_API void	winpty_config_free (winpty_config_t *cfg)
WINPTY_API void	winpty_config_set_initial_size (winpty_config_t *cfg, int cols, int rows)
WINPTY_API void	winpty_config_set_mouse_mode (winpty_config_t *cfg, int mouseMode)
WINPTY_API void	winpty_config_set_agent_timeout (winpty_config_t *cfg, DWORD timeoutMs)
WINPTY_API winpty_t *	winpty_open (const winpty_config_t *cfg, winpty_error_ptr_t *err)
WINPTY_API HANDLE	winpty_agent_process (winpty_t *wp)
WINPTY_API LPCWSTR	winpty_conin_name (winpty_t *wp)
WINPTY_API LPCWSTR	winpty_conout_name (winpty_t *wp)
WINPTY_API LPCWSTR	winpty_conerr_name (winpty_t *wp)
WINPTY_API winpty_spawn_config_t *	winpty_spawn_config_new (UINT64 spawnFlags, LPCWSTR appname, LPCWSTR cmdline, LPCWSTR cwd, LPCWSTR env, winpty_error_ptr_t *err)
WINPTY_API void	winpty_spawn_config_free (winpty_spawn_config_t *cfg)
WINPTY_API BOOL	winpty_spawn (winpty_t *wp, const winpty_spawn_config_t *cfg, HANDLE *process_handle, HANDLE *thread_handle, DWORD *create_process_error, winpty_error_ptr_t *err)
WINPTY_API BOOL	winpty_set_size (winpty_t *wp, int cols, int rows, winpty_error_ptr_t *err)
WINPTY_API void	winpty_free (winpty_t *wp)

Macro Definition Documentation

WINPTY_API

#define WINPTY_API   __declspec(dllimport)

Typedef Documentation

winpty_config_t

typedef struct winpty_config_s winpty_config_t

winpty_error_ptr_t

typedef winpty_error_t* winpty_error_ptr_t

winpty_error_t

typedef struct winpty_error_s winpty_error_t

winpty_result_t

typedef DWORD winpty_result_t

winpty_spawn_config_t

typedef struct winpty_spawn_config_s winpty_spawn_config_t

winpty_t

typedef struct winpty_s winpty_t

Function Documentation

winpty_agent_process()

WINPTY_API HANDLE winpty_agent_process

(

winpty_t *

wp

)

winpty_conerr_name()

WINPTY_API LPCWSTR winpty_conerr_name

(

winpty_t *

wp

)

winpty_config_free()

WINPTY_API void winpty_config_free

(

winpty_config_t *

cfg

)

winpty_config_new()

WINPTY_API winpty_config_t* winpty_config_new	(	UINT64	agentFlags,
		winpty_error_ptr_t *	err
	)

winpty_config_set_agent_timeout()

WINPTY_API void winpty_config_set_agent_timeout	(	winpty_config_t *	cfg,
		DWORD	timeoutMs
	)

winpty_config_set_initial_size()

WINPTY_API void winpty_config_set_initial_size	(	winpty_config_t *	cfg,
		int	cols,
		int	rows
	)

winpty_config_set_mouse_mode()

WINPTY_API void winpty_config_set_mouse_mode	(	winpty_config_t *	cfg,
		int	mouseMode
	)

winpty_conin_name()

WINPTY_API LPCWSTR winpty_conin_name

(

winpty_t *

wp

)

winpty_conout_name()

WINPTY_API LPCWSTR winpty_conout_name

(

winpty_t *

wp

)

winpty_error_code()

WINPTY_API winpty_result_t winpty_error_code

(

winpty_error_ptr_t

err

)

winpty_error_free()

WINPTY_API void winpty_error_free

(

winpty_error_ptr_t

err

)

winpty_error_msg()

WINPTY_API LPCWSTR winpty_error_msg

(

winpty_error_ptr_t

err

)

winpty_free()

WINPTY_API void winpty_free

(

winpty_t *

wp

)

winpty_open()

WINPTY_API winpty_t* winpty_open	(	const winpty_config_t *	cfg,
		winpty_error_ptr_t *	err
	)

winpty_set_size()

WINPTY_API BOOL winpty_set_size	(	winpty_t *	wp,
		int	cols,
		int	rows,
		winpty_error_ptr_t *	err
	)

winpty_spawn()

WINPTY_API BOOL winpty_spawn	(	winpty_t *	wp,
		const winpty_spawn_config_t *	cfg,
		HANDLE *	process_handle,
		HANDLE *	thread_handle,
		DWORD *	create_process_error,
		winpty_error_ptr_t *	err
	)

winpty_spawn_config_free()

WINPTY_API void winpty_spawn_config_free

(

winpty_spawn_config_t *

cfg

)

winpty_spawn_config_new()

WINPTY_API winpty_spawn_config_t* winpty_spawn_config_new	(	UINT64	spawnFlags,
		LPCWSTR	appname,
		LPCWSTR	cmdline,
		LPCWSTR	cwd,
		LPCWSTR	env,
		winpty_error_ptr_t *	err
	)