windows

Documentation

Index

• func Arch() string
• func CreateJunctions(junctions ...[2]string) error
• func CreateShortcuts(shortcuts ...Shortcut) error
• func ExtractDir(dirToExtract, destinationDir string) error
• func ForceRemoveAll(path string) error
• func GetDirFilenames(dir string) ([]string, error)
• func GetFolderPath(folderType string) (string, error)
• func GetPersistentEnvValue(key string) (string, string, error)
• func GetPersistentEnvValues() (map[string]string, error)
• func GetShellExecutable() (string, error)
• func RunAndPipeInto(executable string, args []string, lines []string) error
• func RunPowershellScript(lines []string, loadProfile bool) error
• func SetPersistentEnvValue(key, value string) error
• func SetPersistentEnvValues(vars ...[2]string) error
• type PROCESSENTRY32
• type Paths
  • func ParsePath(value string) Paths
  • func (p Paths) Prepend(paths ...string) Paths
  • func (p Paths) Remove(paths ...string) Paths
  • func (p Paths) String() string
• type Shortcut

Functions

func Arch

func Arch() string

Arch retrieves the runtime architecture. This might differ from the compile time architecture. hence GOARCH can't be used here.

func CreateJunctions

func CreateJunctions(junctions ...[2]string) error

CreateJunction will create multiple junctions. Each pair reflects one junction ([2]string{existing_dir, link_location}). A junction as a hardlink to a directory. This means, that we hardlink to the drive-sections, which results in deletions not affecting the actual data, as long as there are still references.

func CreateShortcuts

func CreateShortcuts(shortcuts ...Shortcut) error

func ExtractDir

func ExtractDir(dirToExtract, destinationDir string) error

ExtractDir will move all files of a given to the target directory

func ForceRemoveAll

func ForceRemoveAll(path string) error

ForceRemoveAll will delete any file or folder recursively. This will not delete the content of junctions.

func GetDirFilenames

func GetDirFilenames(dir string) ([]string, error)

func GetFolderPath

func GetFolderPath(folderType string) (string, error)

GetFolderPath is equivalent to [Environment]::GetFolderPath and determines user-specific folder locations.

func GetPersistentEnvValue

func GetPersistentEnvValue(key string) (string, string, error)

GetPersistentEnvValue retrieves a persistent user level environment variable. The first returned value is the key and the second the value. While the key is defined in the query, the casing might be different, which COULD matter. If nothing was found, we return empty strings without an error.

func GetPersistentEnvValues

func GetPersistentEnvValues() (map[string]string, error)

func GetShellExecutable

func GetShellExecutable() (string, error)

func RunAndPipeInto

func RunAndPipeInto(executable string, args []string, lines []string) error

func RunPowershellScript

func RunPowershellScript(lines []string, loadProfile bool) error

RunPowershellScript will try running a powershell script using pwsh or powershell. This is dependent on the current shell. If the shell isn't supported, we fallback to powershell. This command blocks til all lines have been executed.

func SetPersistentEnvValue

func SetPersistentEnvValue(key, value string) error

Sets a User-Level Environment variable. An empty value will remove the key completly.

func SetPersistentEnvValues

func SetPersistentEnvValues(vars ...[2]string) error

Types

type PROCESSENTRY32

type PROCESSENTRY32 struct {
	Size uint32

	ProcessID uint32

	ParentProcessID uint32

	// ExeFile is expected to be at max 260 chars, as windows by default doesn't
	// support long paths. While this could fail, we'll ignore this for now, as
	// it is unlikely to happen.
	ExeFile [260]uint16
	// contains filtered or unexported fields
}

PROCESSENTRY32 is a process as defined by Windows. We've simple padded everything with unused field, to be able to parse everything and indicate that the fields are unused at the same time.

type Paths

type Paths []string

func ParsePath

func ParsePath(value string) Paths

ParsePath will break the path variable content down into separate paths. This also handles quoting. The order is preserved.

func (Paths) Prepend

func (p Paths) Prepend(paths ...string) Paths

Preprend will create a new Paths object, adding the supplied paths infront, using the given order.

func (Paths) Remove

func (p Paths) Remove(paths ...string) Paths

Remove returns a new path object that doesn't contain any of the specified paths.

func (Paths) String

func (p Paths) String() string

Creates a new path string, where all entries are quoted.

type Shortcut

type Shortcut struct {
	// Dir is the location to create the shortcut in
	Dir string
	// LinkTarget is the location of the executable to be run.
	LinkTarget string
	// Alias is the name displayed in the explorer / startmenu.
	Alias string
	// Args are optional commandline arguments.
	Args string
	// Icon is an optional image displayed in the explorer / startmenu.
	Icon string
}