const (// RegBase is the registry path inside HKEY_LOCAL_MACHINE where registry settings// are stored. This constant is a non-empty string only when GOOS=windows.RegBase = regBase// RegPolicyBase is the registry path inside HKEY_LOCAL_MACHINE where registry// policies are stored. This constant is a non-empty string only when// GOOS=windows.RegPolicyBase = regPolicyBase)

var ErrNoValue =errors.New("no value because registry is unavailable on this OS")

funcGetPolicyInteger¶added inv1.22.0

func GetPolicyInteger(namestring) (uint64,error)

GetPolicyInteger looks up a registry value in the local machine's path forsystem policies, or returns 0 and the associated error.Use this function to read values that may be set by sysadmins via the MSIinstaller or via GPO. For registry settings that you do *not* want to bevisible to sysadmin tools, use GetRegInteger instead.

This function will only work on GOOS=windows. Trying to run it on any otherOS will always return 0 and ErrNoValue.If value does not exist or another error happens, returns 0 and error.

funcGetPolicyString¶added inv1.22.0

func GetPolicyString(namestring) (string,error)

GetPolicyString looks up a registry value in the local machine's path forsystem policies, or returns empty string and the error.Use this function to read values that may be set by sysadmins via the MSIinstaller or via GPO. For registry settings that you do *not* want to bevisible to sysadmin tools, use GetRegString instead.

This function will only work on GOOS=windows. Trying to run it on any otherOS will always return an empty string and ErrNoValue.If value does not exist or another error happens, returns empty string and error.

funcGetPolicyStringArray¶added inv1.66.0

func GetPolicyStringArray(namestring) ([]string,error)

funcGetRegInteger¶added inv1.16.0

func GetRegInteger(namestring) (uint64,error)

GetRegInteger looks up a registry path in the local machine path, or returns0 and the error.

This function will only work on GOOS=windows. Trying to run it on any otherOS will always return 0 and ErrNoValue.If value does not exist or another error happens, returns 0 and error.

funcGetRegString¶

func GetRegString(namestring) (string,error)

GetRegString looks up a registry path in the local machine path, or returnsan empty string and error.

This function will only work on GOOS=windows. Trying to run it on any otherOS will always return an empty string and ErrNoValue.If value does not exist or another error happens, returns empty string and error.

funcIsCurrentProcessElevated¶added inv1.36.0

func IsCurrentProcessElevated()bool

funcIsSIDValidPrincipal¶added inv1.22.0

func IsSIDValidPrincipal(uidstring)bool

IsSIDValidPrincipal determines whether the SID contained in uid represents atype that is a valid security principal under Windows. This check helps uswork around a bug in the standard library's Windows implementation ofLookupId in os/user.Seehttps://github.com/tailscale/tailscale/issues/869

This function will only work on GOOS=windows. Trying to run it on any otherOS will always return false.

funcLookupPseudoUser¶added inv1.34.0

func LookupPseudoUser(uidstring) (*user.User,error)

LookupPseudoUser attempts to resolve the user specified by uid by checkingagainst well-known pseudo-users on Windows. This is a temporary workarounduntilhttps://github.com/golang/go/issues/49509 is resolved and shipped.

This function will only work on GOOS=windows. Trying to run it on any otherOS will always return an error.

funcRegisterForRestart¶added inv1.50.0

func RegisterForRestart(optsRegisterForRestartOpts)error

RegisterForRestart registers the current process' restart preferences withthe Windows Restart Manager. This enables the OS to intelligently restartthe calling executable as requested via opts. This should be called by anyprograms which need to be restarted by the installer post-update.

This function may be called multiple times; the opts from the most recentcall will override those from any previous invocations.

This function will only work on GOOS=windows. Trying to run it on any otherOS will always return nil.

typeRegisterForRestartOpts¶added inv1.50.0

type RegisterForRestartOpts struct {RestartOnCrashbool// When true, this program will be restarted after a crash.RestartOnHangbool// When true, this program will be restarted after a hang.RestartOnUpgradebool// When true, this program will be restarted after an upgrade.RestartOnRebootbool// When true, this program will be restarted after a reboot.UseCmdLineArgsbool// When true, CmdLineArgs will be used as the program's arguments upon restart. Otherwise no arguments will be provided.CmdLineArgs      []string// When UseCmdLineArgs == true, contains the command line arguments, excluding the executable name itself. If nil or empty, the arguments from the current process will be re-used.}

RegisterForRestartOpts supplies options to RegisterForRestart.