Public/winfsp
1
0
Fork 0
mirror of https://github.com/winfsp/winfsp.git synced 2025-04-23 00:43:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

inc: launch.h: documentation

Browse Source
This commit is contained in:
Bill Zissimopoulos 2018-01-11 16:35:56 -08:00
parent 77f3e064a2
commit 2b6b049f86
No known key found for this signature in database
GPG Key ID: 3D4F95D52C7B3EA3
1 changed files with 43 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
inc/winfsp/launch.h
View File

@ -2,7 +2,7 @@
* @file winfsp/launch.h * @file winfsp/launch.h
* WinFsp Launch API. * WinFsp Launch API.
* *
* In order to use the WinFsp API the user mode file system must include <winfsp/winfsp.h> * In order to use the WinFsp Launch API a program must include <winfsp/launch.h>
* and link with the winfsp_x64.dll (or winfsp_x86.dll) library. * and link with the winfsp_x64.dll (or winfsp_x86.dll) library.
* *
* @copyright 2015-2018 Bill Zissimopoulos * @copyright 2015-2018 Bill Zissimopoulos
@ -131,7 +131,7 @@ FSP_API NTSTATUS FspLaunchCallLauncherPipe(
* reported through PLauncherError. * reported through PLauncherError.
*/ */
FSP_API NTSTATUS FspLaunchStart( FSP_API NTSTATUS FspLaunchStart(
PWSTR ClassName, PWSTR InstanceName, ULONG Argc, PWSTR *Argv0, PWSTR ClassName, PWSTR InstanceName, ULONG Argc, PWSTR *Argv,
BOOLEAN HasSecret, BOOLEAN HasSecret,
PULONG PLauncherError); PULONG PLauncherError);
/** /**
@ -202,10 +202,13 @@ FSP_API NTSTATUS FspLaunchGetNameList(
PULONG PLauncherError); PULONG PLauncherError);
/** /**
* @group Registry * @group Service Registry
*/ */
#pragma warning(push) #pragma warning(push)
#pragma warning(disable:4200) /* zero-sized array in struct/union */ #pragma warning(disable:4200) /* zero-sized array in struct/union */
/**
* Service registry record.
*/
typedef struct _FSP_LAUNCH_REG_RECORD typedef struct _FSP_LAUNCH_REG_RECORD
{ {
PWSTR Agent; PWSTR Agent;
@ -221,12 +224,48 @@ typedef struct _FSP_LAUNCH_REG_RECORD
UINT8 Buffer[]; UINT8 Buffer[];
} FSP_LAUNCH_REG_RECORD; } FSP_LAUNCH_REG_RECORD;
#pragma warning(pop) #pragma warning(pop)
/**
* Add/change/delete a service registry record.
*
* @param ClassName
* The service class name.
* @param Record
* The record to set in the registry. If NULL, the registry record is deleted.
* @return
* STATUS_SUCCESS or error code.
*/
FSP_API NTSTATUS FspLaunchRegSetRecord( FSP_API NTSTATUS FspLaunchRegSetRecord(
PWSTR ClassName, PWSTR ClassName,
const FSP_LAUNCH_REG_RECORD *Record); const FSP_LAUNCH_REG_RECORD *Record);
/**
* Get a service registry record.
*
* @param ClassName
* The service class name.
* @param Agent
* The name of the agent that is retrieving the service record. This API matches
* the supplied Agent against the Agent in the service record and it only returns
* the record if they match. Pass NULL to match any Agent.
* @param PRecord
* Pointer to a record pointer. Memory for the service record will be allocated
* and a pointer to it will be stored at this address. This memory must be later
* freed using FspLaunchRegFreeRecord.
* @return
* STATUS_SUCCESS or error code.
* @see
* FspLaunchRegFreeRecord
*/
FSP_API NTSTATUS FspLaunchRegGetRecord( FSP_API NTSTATUS FspLaunchRegGetRecord(
PWSTR ClassName, PWSTR Agent, PWSTR ClassName, PWSTR Agent,
FSP_LAUNCH_REG_RECORD **PRecord); FSP_LAUNCH_REG_RECORD **PRecord);
/**
* Free a service registry record.
*
* @param Record
* The service record to free.
* @see
* FspLaunchRegGetRecord
*/
FSP_API VOID FspLaunchRegFreeRecord( FSP_API VOID FspLaunchRegFreeRecord(
FSP_LAUNCH_REG_RECORD *Record); FSP_LAUNCH_REG_RECORD *Record);