Support

This category covers the various support and diagnostics functions available on the API.

Enumerations

enum HSDCPolicyFormat : DWORD { HSDCPolicyFormatOffline = 0, HSDCPolicyFormatCch, HSDCPolicyFormatSkr }

These are the possible values for the formatting of dumped policies.

Functions

HSDCError HSDCAPI HSDCDumpPolicies (DWORD format, const wchar_t *path, char **pJstr)

Produces a textual representation of the current agent policies.

const wchar_t *const HSDCAPI HSDCErrorGetName (HSDCError error)

Gets a pointer to a const wchar_t c-string based on the input error enum. Used to fetch an error name without switches.

Enumeration Type Documentation

HSDCPolicyFormat

enum HSDCPolicyFormat : DWORD

These are the possible values for the formatting of dumped policies.

Enumerators

HSDCPolicyFormatOffline

Device Control offline policies (usually with .dat extension)

HSDCPolicyFormatCch

IDAC Agent Service (SComC) policies (default filename: %WINDIR%\sxdata\cchv0030.cch)

HSDCPolicyFormatSkr

IDAC kernel driver (SK) policies (default filename: %WINDIR%\sxdata\skrv0010.skr)

Function Documentation

HSDCDumpPolicies()

HSDCError HSDCAPI HSDCDumpPolicies ( DWORD format, const wchar_t * path, char ** pJstr )

Produces a textual representation of the current agent policies.

Parameters

format

One of the HSDCPolicyFormat values. The Skr file is platform dependent, i.e. on an x64 platform, HSDC64.DLL must be used to perform the export. The two other formats are not subject to platform bitness.

path

Unicode filename for the input. nullptr can be passed to use the default filename for options HSDCPolicyFormatCch or HSDCPolicyFormatSkr.

pJstr

[out] HSDCPolicyFormatOffline and HSDCPolicyFormatCch produce the same output format, while HSDCPolicyFormatSkr has an alternate output format. Check annexes for partial examples but the format is subject to chance and is intended to be used by LES support team.

HSDCErrorGetName()

const wchar_t* const HSDCAPI HSDCErrorGetName ( HSDCError error )

Gets a pointer to a const wchar_t c-string based on the input error enum.

Used to fetch an error name without switches or the like:

Copy 
std::wcout << L"Log Registries update returned: "
    << HSDCErrorGetName(HSDCSetLogging(json)) << std::endl;
Parameters

error

An enum value for which you wish to receive the string version.
Returns

The member of HSDCErrorNames that is the string version of the enum. Otherwise it returns the value HSDCErrorInvalidHsdcErrorCode.