Step 1: Review Your Packages

Step 2: Choose Your Integration Method

Step 3: Copy Your Script or Download Config

Option 1: Copy Script

Option 2: Download Config

Step 4: Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)

Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the packages and push them to a repository
  Download Packages

Option 2: Internalized Package (Reliable, Scalable)

Open Source
- Download the packages:
  Download Packages
- Follow manual internalization instructions
Package Internalizer (C4B)
- Run: (additional options)
- For package and dependencies run:
- Automate package internalization

Step 5: Copy Your Script

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:

If Applicable - Chocolatey Configuration/Installation


## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###

#### We initialize a few things that are needed by this script - there are no other requirements.
$ErrorActionPreference = "Stop"

#### Set TLS 1.2 (3072) as that is the minimum required by various up-to-date repositories.
#### Use integers because the enumeration value for TLS 1.2 won't exist
#### in .NET 4.0, even though they are addressable if .NET 4.5+ is
#### installed (.NET 4.5 is an in-place upgrade).
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072

#### We use this variable for future REST calls.
$RequestArguments = @{
    UseBasicParsing = $true
}

## 2. TOP LEVEL VARIABLES ##

### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
$NugetRepositoryUrl = "INTERNAL REPO URL"

### b. Internal Repository Credential ###
#### If required, add the repository access credential here
# $NugetRepositoryCredential = [PSCredential]::new(
#     "username",
#     ("password" | ConvertTo-SecureString -AsPlainText -Force)
# )
# $RequestArguments.Credential = $NugetRepositoryCredential

### c. Chocolatey nupkg download url ###
#### This url should result in an immediate download when you navigate to it
$ChocolateyDownloadUrl = "$($NugetRepositoryUrl.TrimEnd('/'))/package/chocolatey.2.4.3.nupkg"

### d. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
# $ChocolateyCentralManagementUrl = "https://chocolatey-central-management:24020/ChocolateyManagementService"

#### ii. If using a Client Salt, add it here
# $ChocolateyCentralManagementClientSalt = "clientsalt"

#### iii. If using a Service Salt, add it here
# $ChocolateyCentralManagementServiceSalt = "servicesalt"

## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository

#### Download the Nupkg, appending .zip to the filename to handle archive cmdlet limitations
if (-not (Get-Command choco.exe -ErrorAction SilentlyContinue)) {
    $TempDirectory = Join-Path $env:Temp "chocolateyInstall"
    if (-not (Test-Path $TempDirectory -PathType Container)) {
        $null = New-Item -Path $TempDirectory -ItemType Directory
    }
    $DownloadedNupkg = Join-Path $TempDirectory "$(Split-Path $ChocolateyDownloadUrl -Leaf).zip"
    Invoke-WebRequest -Uri $ChocolateyDownloadUrl -OutFile $DownloadedNupkg @RequestArguments

    #### Extract the Nupkg, and run the chocolateyInstall script
    if (Get-Command Microsoft.PowerShell.Archive\Expand-Archive -ErrorAction SilentlyContinue) {
        Microsoft.PowerShell.Archive\Expand-Archive -Path $DownloadedNupkg -DestinationPath $TempDirectory -Force
    } else {
        # PowerShell versions <4.0 do not have this function available
        try {
            $shellApplication = New-Object -ComObject Shell.Application
            $zipPackage = $shellApplication.NameSpace($DownloadedNupkg)
            $destinationFolder = $shellApplication.NameSpace($TempDirectory)
            $destinationFolder.CopyHere($zipPackage.Items(), 0x10)
        } catch {
            Write-Warning "Unable to unzip package using built-in compression."
            throw $_
        }
    }

    & $(Join-Path $TempDirectory "tools\chocolateyInstall.ps1")
}

if (-not (Get-Command choco.exe -ErrorAction SilentlyContinue)) {
    refreshenv
}

## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations
# choco feature enable -n useFipsCompliantChecksums

### b. Apply Recommended Configuration ###
#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
choco config set --name cacheLocation --value C:\ProgramData\chocolatey\cache

#### Increase timeout to at least 4 hours
choco config set --name commandExecutionTimeoutSeconds --value 14400

#### Turn off download progress when running choco through integrations
choco feature disable --name showDownloadProgress

### c. Sources ###
#### Remove the default community package repository source
choco source list --limitoutput | ConvertFrom-Csv -Header 'Name', 'Location' -Delimiter '|' | ForEach-Object {
    if ($_.Location -eq 'https://community.chocolatey.org/api/v2/') {
        choco source remove -n $_.Name
    }
}

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here

#### NOTE: This EXAMPLE may require changes
if ($NugetRepositoryCredential) {
    choco source add --name ChocolateyInternal --source $NugetRepositoryUrl --user $NugetRepositoryCredential.UserName --password $NugetRepositoryCredential.GetNetworkCredential().Password --priority 1
} else {
    choco source add --name ChocolateyInternal --source $NugetRepositoryUrl --priority 1
}

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/
choco upgrade chocolatey --confirm

## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.

### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/how-tos/setup-offline-installation#exercise-4-create-a-package-for-the-license
choco install chocolatey-license --source $NugetRepositoryUrl --confirm

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
if ("chocolatey-license" -in (choco list --localonly --limitoutput | ConvertFrom-Csv -Header "Name" -Delimiter "|").Name) {
    choco source disable --name chocolatey.licensed
} else {
    Write-Warning "Not disabling 'chocolatey.licensed' feed, as Chocolatey-License has not been installed."
}

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
if ("chocolatey-license" -in (choco list --localonly --limitoutput | ConvertFrom-Csv -Header "Name" -Delimiter "|").Name) {
    choco install chocolatey.extension --source $NugetRepositoryUrl --confirm
} else {
    Write-Warning "Not installing 'chocolatey.extension', as Chocolatey-License has not been installed."
}

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
choco feature disable --name showNonElevatedWarnings
choco feature enable --name useBackgroundService
choco feature enable --name useBackgroundServiceWithNonAdministratorsOnly
choco feature enable --name allowBackgroundServiceUninstallsFromUserInstallsOnly
choco config set --name allowedBackgroundServiceCommands --value "install,upgrade,uninstall"

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
if ($ChocolateyCentralManagementUrl) {
    choco install chocolatey-agent --source $NugetRepositoryUrl --confirm
    choco config set --name CentralManagementServiceUrl --value $ChocolateyCentralManagementUrl
    if ($ChocolateyCentralManagementClientSalt) {
        choco config set --name centralManagementClientCommunicationSaltAdditivePassword --value $ChocolateyCentralManagementClientSalt
    }
    if ($ChocolateyCentralManagementServiceSalt) {
        choco config set --name centralManagementServiceCommunicationSaltAdditivePassword --value $ChocolateyCentralManagementServiceSalt
    }
    choco feature enable --name useChocolateyCentralManagement
    choco feature enable --name useChocolateyCentralManagementDeployments
}

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

If Applicable - Chocolatey Configuration/Installation


## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###
#### i. chocolatey.chocolatey
##### You will require the chocolatey.chocolatey collection to be installed
##### on all machines using this playbook.
##### Please see https://github.com/chocolatey/chocolatey-ansible/#installing-the-collection-from-ansible-galaxy

- name: Install and Configure Chocolatey
  hosts: all

## 2. TOP LEVEL VARIABLES ##
  vars:

### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
    nuget_repository_url: INTERNAL REPO URL

### b. Internal Repository Credential ###
#### If required, add the repository access credential here and
#### uncomment lines with source_username and source_password below
#    nuget_repository_username: username
#    nuget_repository_password: password

### c. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
#    chocolatey_central_management_url: https://chocolatey-central-management:24020/ChocolateyManagementService

#### ii. If using a Client Salt, add it here
#    chocolatey_central_management_client_salt: clientsalt

#### iii. If using a Service Salt, add it here
#    chocolatey_central_management_service_salt: servicesalt

## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository

  tasks:
  - name: Install chocolatey
    win_chocolatey:
      name: chocolatey
      source: ""{{ nuget_repository_url }}""
      # source_username: ""{{ nuget_repository_username }}""
      # source_password: ""{{ nuget_repository_password }}""

## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations
#   - name: Enable FIPS compliance
#     win_chocolatey_feature:
#       name: useFipsCompliantChecksums
#       state: enabled

### b. Apply Recommended Configuration ###

#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
  - name: Set the cache location
    win_chocolatey_config:
      name: cacheLocation
      state: present
      value: C:\ProgramData\chocolatey\cache

#### Increase timeout to at least 4 hours
  - name: Set the command execution timeout
    win_chocolatey_config:
      name: commandExecutionTimeoutSeconds
      state: present
      value: 14400

#### Turn off download progress when running choco through integrations
  - name: Disable showing download progress
    win_chocolatey_feature:
      name: showDownloadProgress
      state: disabled

### c. Sources ###
#### Remove the default community package repository source
  - name: Remove Chocolatey Community Repository
    win_chocolatey_source:
      name: chocolatey
      state: absent

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here
#### NOTE: This EXAMPLE may require changes
  - name: Add Internal Repository
    win_chocolatey_source:
      name: ChocolateyInternal
      state: present
      source: {{ nuget_repository_url }}
      # source_username: {{ nuget_repository_username }}
      # source_password: {{ nuget_repository_password }}
      priority: 1

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/
  - name: Upgrade Chocolatey
    win_chocolatey:
      name: chocolatey
      state: latest

## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.
### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/how-tos/setup-offline-installation#exercise-4-create-a-package-for-the-license
  - name: Install Chocolatey License
    win_chocolatey:
      name: chocolatey-license
      source: ChocolateyInternal
      state: latest

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
  - name: Disable Chocolatey Community Repository
    win_chocolatey_source:
      name: chocolatey.licensed
      state: disabled

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
  - name: Install Chocolatey Extension
    win_chocolatey:
      name: chocolatey.extension
      source: ChocolateyInternal
      state: latest

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
  - name: Hide not-elevated warnings
    win_chocolatey_feature:
      name: showNonElevatedWarnings
      state: disabled

  - name: Use background mode for self-service
    win_chocolatey_feature:
      name: useBackgroundService
      state: enabled

  - name: Use background service for non-admins
    win_chocolatey_feature:
      name: useBackgroundServiceWithNonAdministratorsOnly
      state: enabled

  - name: Allow background uninstallation for user installs
    win_chocolatey_feature:
      name: allowBackgroundServiceUninstallsFromUserInstallsOnly
      state: enabled

  - name: Set allowed background service commands
    win_chocolatey_config:
      name: backgroundServiceAllowedCommands
      state: present
      value: install,upgrade,uninstall

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
  - name: Install Chocolatey Agent
    when: chocolatey_central_management_url is defined
    win_chocolatey:
      name: chocolatey-agent
      source: ChocolateyInternal
      state: latest

  - name: Set the Central Management Service URL
    when: chocolatey_central_management_url is defined
    win_chocolatey_config:
      name: CentralManagementServiceUrl
      state: present
      value: {{ chocolatey_central_management_url }}

  - name: Set the Central Management Client Salt
    when: chocolatey_central_management_client_salt is defined
    win_chocolatey_config:
      name: centralManagementClientCommunicationSaltAdditivePassword
      state: present
      value: {{ chocolatey_central_management_client_salt }}

  - name: Set the Central Management Service Salt
    when: chocolatey_central_management_service_salt is defined
    win_chocolatey_config:
      name: centralManagementServiceCommunicationSaltAdditivePassword
      state: present
      value: {{ chocolatey_central_management_service_salt }}

  - name: Use Central Management
    when: chocolatey_central_management_url is defined
    win_chocolatey_feature:
      name: useChocolateyCentralManagement
      state: enabled

  - name: Use Central Management Deployments
    when: chocolatey_central_management_url is defined
    win_chocolatey_feature:
      name: useChocolateyCentralManagementDeployments
      state: enabled

See docs at https://docs.chef.io/resource_chocolatey_package.html.

If Applicable - Chocolatey Configuration/Installation


## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###
#### The Chocolatey resources are available with any recent version of Chef.
#### We utilise the Chocolatey recipe to install the Chocolatey binaries.
include_recipe "chocolatey"

## 2. TOP LEVEL VARIABLES ##
### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
NugetRepositoryUrl = "INTERNAL REPO URL"

### b. Internal Repository Credential ###
#### If required, add the repository access credential here
# NugetRepositoryUsername = "username"
# NugetRepositoryPassword = "password"

### c. Chocolatey nupkg download url ###
#### This url should result in an immediate download when you navigate to it in
#### a web browser
ChocolateyNupkgUrl = "INTERNAL REPO URL/package/chocolatey.2.4.3.nupkg",

### d. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
# ChocolateyCentralManagementUrl = "https://chocolatey-central-management:24020/ChocolateyManagementService"

#### ii. If using a Client Salt, add it here
# ChocolateyCentralManagementClientSalt = "clientsalt"

#### iii. If using a Service Salt, add it here
# ChocolateyCentralManagementServiceSalt = "servicesalt"

## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository
node['chocolatey']['install vars'] = {
  'chocolateyDownloadUrl' => "#{ChocolateyNupkgUrl}",
}

## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations
# chocolatey_feature 'useFipsCompliantChecksums' do
#   action :enable
# end

### b. Apply Recommended Configuration ###

#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
chocolatey_config 'cacheLocation' do
  value 'C:\ProgramData\chocolatey\cache'
end

#### Increase timeout to at least 4 hours
chocolatey_config 'commandExecutionTimeoutSeconds' do
  value '14400'
end

#### Turn off download progress when running choco through integrations
chocolatey_feature 'showDownloadProgress' do
  action :disable
end

### c. Sources ###
#### Remove the default community package repository source
chocolatey_source 'chocolatey' do
  action :remove
end

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here

#### NOTE: This EXAMPLE may require changes
chocolatey_source 'ChocolateyInternal' do
  source "#{NugetRepositoryUrl}"
  priority 1
  action   :add
end

execute 'ChocolateyInternal' do
  command "choco source add --name ChocolateyInternal -s #{NugetRepositoryUrl} -u=#{NugetRepositoryUsername} -p=#{NugetRepositoryPassword} --priority=1"
  only_if { NugetRepositoryUsername != nil || NugetRepositoryPassword != nil }
end

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/
chocolatey_package 'chocolatey' do
  action :upgrade
  source "#{NugetRepositoryUrl}"
end

## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.

### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/how-tos/setup-offline-installation#exercise-4-create-a-package-for-the-license
chocolatey_package 'chocolatey-license' do
  action :install
  source "#{NugetRepositoryUrl}"
end

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
chocolatey_source 'chocolatey.licensed' do
  action            :disable
end

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
chocolatey_package 'chocolatey.extention' do
  action     install
  source     "#{NugetRepositoryUrl}"
end

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
chocolatey_feature 'showNonElevatedWarnings' do
  action :disable
end

chocolatey_feature 'useBackgroundService' do
  action :enable
end

chocolatey_feature 'useBackgroundServiceWithNonAdministratorsOnly' do
  action :enable
end

chocolatey_feature 'allowBackgroundServiceUninstallsFromUserInstallsOnly' do
  action :enable
end

chocolatey_config 'backgroundServiceAllowedCommands' do
  value 'install,upgrade,uninstall'
end

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
chocolatey_package 'chocolatey-agent' do
  action     install
  source     "#{NugetRepositoryUrl}"
  # user       "#{NugetRepositoryUsername}"
  # password   "#{NugetRepositoryPassword}"
  only_if { ChocolateyCentralManagementUrl != nil }
end

chocolatey_config 'CentralManagementServiceUrl' do
  value  "#{ChocolateyCentralManagementUrl}"
  only_if { ChocolateyCentralManagementUrl != nil }
end

chocolatey_config 'centralManagementClientCommunicationSaltAdditivePassword' do
  value   "#{ChocolateyCentralManagementClientSalt}"
  only_if { ChocolateyCentralManagementClientSalt != nil }
end

chocolatey_config 'centralManagementServiceCommunicationSaltAdditivePassword' do
  value   "#{ChocolateyCentralManagementServiceSalt}"
  only_if { ChocolateyCentralManagementServiceSalt != nil }
end

chocolatey_feature 'useChocolateyCentralManagement' do
  action :enable
  only_if { ChocolateyCentralManagementUrl != nil }
end

chocolatey_feature 'useChocolateyCentralManagementDeployments' do
  action :enable
  only_if { ChocolateyCentralManagementUrl != nil }
end

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.

If Applicable - Chocolatey Configuration/Installation


#requires -Modules cChoco
## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###
#### i. Requires chocolatey\cChoco DSC module to be installed on the machine compiling the DSC manifest
#### NOTE: This will need to be installed before running the DSC portion of this script
if (-not (Get-Module cChoco -ListAvailable)) {
    $null = Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force
    if (($PSGallery = Get-PSRepository -Name PSGallery).InstallationPolicy -ne "Trusted") {
        Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
    }
    Install-Module -Name cChoco
    if ($PSGallery.InstallationPolicy -ne "Trusted") {
        Set-PSRepository -Name PSGallery -InstallationPolicy $PSGallery.InstallationPolicy
    }
}

#### ii. Requires a hosted copy of the install.ps1 script
##### This should be available to download without authentication.
##### The original script can be found here: https://community.chocolatey.org/install.ps1

Configuration ChocolateyConfig {
## 2. TOP LEVEL VARIABLES ##
    param(
### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
        $NugetRepositoryUrl      = "INTERNAL REPO URL",

### b. Chocolatey nupkg download url ###
#### This url should result in an immediate download when you navigate to it in
#### a web browser
        $ChocolateyNupkgUrl      = "INTERNAL REPO URL/package/chocolatey.2.4.3.nupkg",

### c. Internal Repository Credential ###
#### If required, add the repository access credential here
#        $NugetRepositoryCredential = [PSCredential]::new(
#            "username",
#            ("password" | ConvertTo-SecureString -AsPlainText -Force)
#        ),

### d. Install.ps1 URL
#### The path to the hosted install script:
        $ChocolateyInstallPs1Url = "https://community.chocolatey.org/install.ps1"

### e. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
#        $ChocolateyCentralManagementUrl = "https://chocolatey-central-management:24020/ChocolateyManagementService",

#### ii. If using a Client Salt, add it here
#        $ChocolateyCentralManagementClientSalt = "clientsalt",

#### iii. If using a Service Salt, add it here
#        $ChocolateyCentralManagementServiceSalt = "servicesalt"
    )
    Import-DscResource -ModuleName PSDesiredStateConfiguration
    Import-DscResource -ModuleName cChoco

    Node 'localhost' {
## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository
        Environment chocoDownloadUrl {
            Name  = "chocolateyDownloadUrl"
            Value = $ChocolateyNupkgUrl
        }

        cChocoInstaller installChocolatey {
            DependsOn = "[Environment]chocoDownloadUrl"
            InstallDir = Join-Path $env:ProgramData "chocolatey"
            ChocoInstallScriptUrl = $ChocolateyInstallPs1Url
        }

## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations
#        cChocoFeature featureFipsCompliance {
#            FeatureName = "useFipsCompliantChecksums"
#        }

### b. Apply Recommended Configuration ###

#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
        cChocoConfig cacheLocation {
            DependsOn  = "[cChocoInstaller]installChocolatey"
            ConfigName = "cacheLocation"
            Value      = "C:\ProgramData\chocolatey\cache"
        }

#### Increase timeout to at least 4 hours
        cChocoConfig commandExecutionTimeoutSeconds {
            DependsOn  = "[cChocoInstaller]installChocolatey"
            ConfigName = "commandExecutionTimeoutSeconds"
            Value      = 14400
        }

#### Turn off download progress when running choco through integrations
        cChocoFeature showDownloadProgress {
            DependsOn   = "[cChocoInstaller]installChocolatey"
            FeatureName = "showDownloadProgress"
            Ensure      = "Absent"
        }

### c. Sources ###
#### Remove the default community package repository source
        cChocoSource removeCommunityRepository {
            DependsOn  = "[cChocoInstaller]installChocolatey"
            Name       = "chocolatey"
            Ensure     = "Absent"
        }

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here.
#### NOTE: This EXAMPLE may require changes
        cChocoSource addInternalSource {
            DependsOn  = "[cChocoInstaller]installChocolatey"
            Name        = "ChocolateyInternal"
            Source      = $NugetRepositoryUrl
            Credentials = $NugetRepositoryCredential
            Priority    = 1
        }

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/
        cChocoPackageInstaller updateChocolatey {
            DependsOn   = "[cChocoSource]addInternalSource", "[cChocoSource]removeCommunityRepository"
            Name        = "chocolatey"
            AutoUpgrade = $true
        }

## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.

### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/how-tos/setup-offline-installation#exercise-4-create-a-package-for-the-license
        cChocoPackageInstaller chocolateyLicense {
            DependsOn = "[cChocoPackageInstaller]updateChocolatey"
            Name      = "chocolatey-license"
        }

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
        Script disableLicensedSource {
            DependsOn  = "[cChocoPackageInstaller]chocolateyLicense"
            GetScript  = {
                $Source = choco source list --limitoutput | `
                    ConvertFrom-Csv -Delimiter '|' -Header Name, Source, Disabled | `
                    Where-Object Name -eq "chocolatey.licensed"

                return @{
                    Result = if ($Source) {
                        [bool]::Parse($Source.Disabled)
                    } else {
                        Write-Warning "Source 'chocolatey.licensed' was not present."
                        $true  # Source does not need disabling
                    }
                }
            }
            SetScript  = {
                $null = choco source disable --name "chocolatey.licensed"
            }
            TestScript = {
                $State = [ScriptBlock]::Create($GetScript).Invoke()
                return $State.Result
            }
        }

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
        cChocoPackageInstaller chocolateyLicensedExtension {
            DependsOn = "[Script]disableLicensedSource"
            Name      = "chocolatey.extension"
        }

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
        cChocoFeature hideElevatedWarnings {
            DependsOn   = "[cChocoPackageInstaller]chocolateyLicensedExtension"
            FeatureName = "showNonElevatedWarnings"
            Ensure      = "Absent"
        }

        cChocoFeature useBackgroundService {
            DependsOn   = "[cChocoPackageInstaller]chocolateyLicensedExtension"
            FeatureName = "useBackgroundService"
            Ensure      = "Present"
        }

        cChocoFeature useBackgroundServiceWithNonAdmins {
            DependsOn   = "[cChocoPackageInstaller]chocolateyLicensedExtension"
            FeatureName = "useBackgroundServiceWithNonAdministratorsOnly"
            Ensure      = "Present"
        }

        cChocoFeature useBackgroundServiceUninstallsForUserInstalls {
            DependsOn   = "[cChocoPackageInstaller]chocolateyLicensedExtension"
            FeatureName = "allowBackgroundServiceUninstallsFromUserInstallsOnly"
            Ensure      = "Present"
        }

        cChocoConfig allowedBackgroundServiceCommands {
            DependsOn   = "[cChocoFeature]useBackgroundService"
            ConfigName = "backgroundServiceAllowedCommands"
            Value       = "install,upgrade,uninstall"
        }

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
        if ($ChocolateyCentralManagementUrl) {
            cChocoPackageInstaller chocolateyAgent {
                DependsOn = "[cChocoPackageInstaller]chocolateyLicensedExtension"
                Name      = "chocolatey-agent"
            }

            cChocoConfig centralManagementServiceUrl {
                DependsOn   = "[cChocoPackageInstaller]chocolateyAgent"
                ConfigName = "CentralManagementServiceUrl"
                Value       = $ChocolateyCentralManagementUrl
            }

            if ($ChocolateyCentralManagementClientSalt) {
                cChocoConfig centralManagementClientSalt {
                    DependsOn  = "[cChocoPackageInstaller]chocolateyAgent"
                    ConfigName = "centralManagementClientCommunicationSaltAdditivePassword"
                    Value      = $ChocolateyCentralManagementClientSalt
                }
            }

            if ($ChocolateyCentralManagementServiceSalt) {
                cChocoConfig centralManagementServiceSalt {
                    DependsOn  = "[cChocoPackageInstaller]chocolateyAgent"
                    ConfigName = "centralManagementServiceCommunicationSaltAdditivePassword"
                    Value      = $ChocolateyCentralManagementServiceSalt
                }
            }

            cChocoFeature useCentralManagement {
                DependsOn   = "[cChocoPackageInstaller]chocolateyAgent"
                FeatureName = "useChocolateyCentralManagement"
                Ensure      = "Present"
            }

            cChocoFeature useCentralManagementDeployments {
                DependsOn   = "[cChocoPackageInstaller]chocolateyAgent"
                FeatureName = "useChocolateyCentralManagementDeployments"
                Ensure      = "Present"
            }
        }
    }
}

# If working this into an existing configuration with a good method for
$ConfigData = @{
    AllNodes = @(
        @{
            NodeName                    = "localhost"
            PSDscAllowPlainTextPassword = $true
        }
    )
}

try {
    Push-Location $env:Temp
    $Config = ChocolateyConfig -ConfigurationData $ConfigData
    Start-DscConfiguration -Path $Config.PSParentPath -Wait -Verbose -Force
} finally {
    Pop-Location
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.

If Applicable - Chocolatey Configuration/Installation


## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###
#### i. Requires puppetlabs/chocolatey module
####  See https://forge.puppet.com/puppetlabs/chocolatey


## 2. TOP LEVEL VARIABLES ##
### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
$_repository_url = 'INTERNAL REPO URL'

### b. Chocolatey nupkg download url ###
#### This url should result in an immediate download when you navigate to it in
#### a web browser
$_choco_download_url = 'INTERNAL REPO URL/package/chocolatey.2.4.3.nupkg'

### c. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
# $_chocolatey_central_management_url = 'https://chocolatey-central-management:24020/ChocolateyManagementService'

#### ii. If using a Client Salt, add it here
# $_chocolatey_central_management_client_salt = "clientsalt"

#### iii. If using a Service Salt, add it here
# $_chocolatey_central_management_service_salt = 'servicesalt'


## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository
### Note: `chocolatey_download_url is completely different than normal
###  source locations. This is directly to the bare download url for the
###  chocolatey.nupkg, similar to what you see when you browse to
###  https://community.chocolatey.org/api/v2/package/chocolatey
class {'chocolatey':
  chocolatey_download_url => $_choco_download_url,
  use_7zip                => false,
}


## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations

#chocolateyfeature {'useFipsCompliantChecksums':
#  ensure => enabled,
#}

### b. Apply Recommended Configuration ###

#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
chocolateyconfig {'cacheLocation':
  value => 'C:\ProgramData\chocolatey\cache',
}

#### Increase timeout to at least 4 hours
chocolateyconfig {'commandExecutionTimeoutSeconds':
  value => '14400',
}

#### Turn off download progress when running choco through integrations
chocolateyfeature {'showDownloadProgress':
  ensure => disabled,
}

### c. Sources ###
#### Remove the default community package repository source
chocolateysource {'chocolatey':
  ensure   => absent,
  location => 'https://community.chocolatey.org/api/v2/',
}

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here

#### NOTE: This EXAMPLE requires changes
chocolateysource {'internal_chocolatey':
  ensure             => present,
  location           => $_repository_url,
  priority           => 1,
  username           => 'optional',
  password           => 'optional,not ensured',
  bypass_proxy       => true,
  admin_only         => false,
  allow_self_service => false,
}

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/

package {'chocolatey':
  ensure   => latest,
  provider => chocolatey,
  source   => $_repository_url,
}


## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.

### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/guides/organizations/organizational-deployment-guide#exercise-4-create-a-package-for-the-license

# TODO: Add resource for installing/ensuring the chocolatey-license package
package {'chocolatey-license':
  ensure   => latest,
  provider => chocolatey,
  source   => $_repository_url,
}

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
## Disabled sources still need all other attributes until
## https://tickets.puppetlabs.com/browse/MODULES-4449 is resolved.
## Password is necessary with user, but not ensurable, so it should not
## matter what it is set to here. If you ever do get into trouble here,
## the password is your license GUID.
chocolateysource {'chocolatey.licensed':
  ensure   => disabled,
  priority => '10',
  user     => 'customer',
  password => '1234',
  require  => Package['chocolatey-license'],
}

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
package {'chocolatey.extension':
  ensure   => latest,
  provider => chocolatey,
  source   => $_repository_url,
  require  => Package['chocolatey-license'],
}

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
chocolateyfeature {'showNonElevatedWarnings':
  ensure => disabled,
}

chocolateyfeature {'useBackgroundService':
  ensure => enabled,
}

chocolateyfeature {'useBackgroundServiceWithNonAdministratorsOnly':
  ensure => enabled,
}

chocolateyfeature {'allowBackgroundServiceUninstallsFromUserInstallsOnly':
  ensure => enabled,
}

chocolateyconfig {'backgroundServiceAllowedCommands':
  value => 'install,upgrade,uninstall',
}

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
if $_chocolatey_central_management_url {
  package {'chocolatey-agent':
    ensure   => latest,
    provider => chocolatey,
    source   => $_repository_url,
    require  => Package['chocolatey-license'],
  }

  chocolateyconfig {'CentralManagementServiceUrl':
    value   => $_chocolatey_central_management_url,
  }

  if $_chocolatey_central_management_client_salt {
    chocolateyconfig {'centralManagementClientCommunicationSaltAdditivePassword':
      value => $_chocolatey_central_management_client_salt,
    }
  }

  if $_chocolatey_central_management_service_salt {
    chocolateyconfig {'centralManagementClientCommunicationSaltAdditivePassword':
      value => $_chocolatey_central_management_client_salt,
    }
  }

  chocolateyfeature {'useChocolateyCentralManagement':
    ensure  => enabled,
    require => Package['chocolatey-agent'],
  }

  chocolateyfeature {'useChocolateyCentralManagementDeployments':
    ensure  => enabled,
    require => Package['chocolatey-agent'],
  }
}

Need Help? View our docs or file an issue.

There is already a version of this package in your Script Builder

Current Version	New Version

Downloads:

1,498

Downloads of v 5.2.0:

1,329

Last Update:

30 Nov 2017

Package Maintainer(s):

yushulx

Software Author(s):

Dynamsoft

Tags:

Dynamsoft Barcode Reader

5.2.0 | Updated: 30 Nov 2017

Downloads:

1,498

Downloads of v 5.2.0:

1,329

Maintainer(s):

yushulx

Software Author(s):

Dynamsoft

Tags:

barcode qr datamatrix pdf417 code39 code93 code128 codabar ean-8 ean-13 upc-a upc-e

Dynamsoft Barcode Reader 5.2.0

Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by Dynamsoft. The inclusion of Dynamsoft trademark(s), if any, upon this webpage is solely to identify Dynamsoft goods or services and not for commercial purposes.

Some Checks Have Failed or Are Not Yet Complete

Not All Tests Have Passed

Hide Checks

Validation Testing Passed

Verification Testing Passed

Details

Scan Testing Resulted in Flagged:

This package was submitted (and approved) prior to automated virus scanning integration into the package moderation processs.

We recommend clicking the "Details" link to make your own decision on installing this package.

Details

Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install Dynamsoft Barcode Reader, run the following command from the command line or from PowerShell:

To upgrade Dynamsoft Barcode Reader, run the following command from the command line or from PowerShell:

To uninstall Dynamsoft Barcode Reader, run the following command from the command line or from PowerShell:

NOTE

This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)

2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)

Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download

Option 2: Internalized Package (Reliable, Scalable)

Open Source
- Download the package:
  Download
- Follow manual internalization instructions

Package Internalizer (C4B)

Run: (additional options)

choco download dbr --internalize --source=https://community.chocolatey.org/api/v2/

For package and dependencies run:

choco push --source="'INTERNAL REPO URL'"

Automate package internalization

3. Copy Your Script

choco upgrade dbr -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade dbr -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode


- name: Install dbr
  win_chocolatey:
    name: dbr
    version: '5.2.0'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'dbr' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '5.2.0'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller dbr
{
    Name     = "dbr"
    Version  = "5.2.0"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'dbr':
  ensure   => '5.2.0',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.

4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Package Approved

This package was approved by moderator AdmiringWorm on 07 Dec 2017.

Description

Dynamsoft's Barcode Reader SDK enables you to efficiently embed barcode reading functionality in your web, desktop and mobile application using just a few lines of code.This can save you from months of added development time and extra costs. With the Barcode Reader SDK, you can decode barcodes from various image file formats (bmp, jpg, png, gif, single-page and multi-page tiff, and PDF). This includes from device-independent bitmap (DIB) formats which can be obtained from cameras or scanners.

Files

tools\LICENSE.txt

From: https://www.dynamsoft.com/Products/barcode-reader-license-agreement.aspx

LICENSE

IMPORTANT: PLEASE READ CAREFULLY.

THE USE OF THIS SOFTWARE IS SUBJECT TO THE TERMS OF THE LICENSE AGREEMENT PRINTED BELOW. IF YOU DO NOT AGREE WITH THE TERMS, THEN YOU SHOULD NOT USE THE SOFTWARE OR ANY PART OF THE SOFTWARE IN ANY WAY. BY USING THIS PRODUCT, YOU AGREE TO BE BOUND BY ALL THE TERMS AND CONDITIONS OF THIS LICENSE AGREEMENT.

THE AGREEMENT

This document is a legal agreement between Dynamsoft Corporation, Canada, hereafter referred to as "Dynamsoft", and the user of the software, hereafter referred to as "You".

DEFINITIONS

"SOFTWARE": The "Dynamsoft Barcode Reader" software and all accompanying components, parts and documentation that have been developed by Dynamsoft.

"Licensee" means the person or entity entering into this Agreement with Dynamsoft. Any person who is entering into this Agreement on behalf of an organizational entity represents that he or she has the authority to bind such entity.

"Application" means an end user program which Licensee develops using the SOFTWARE and into which the Redistributables are incorporated, and which contains significant additional functionality over and above the functionality contained in the SOFTWARE. Read what is counted as a single application to learn more.

"Redistributables" are those runtime libraries and files intended for duplication and distribution with the Application.

"Deployment License" allows Licensee to copy, deploy and redistribute the Redistributables to end users as part of the Application.

"Server" is defined as a computer configured with the intention of multiple users accessing it as a service, or as a background service running as an automated process. The computer has SOFTWARE loaded into its RAM.

"DESKTOP APPLICATION" means a self-contained Application that runs from a local drive and does not require network connectivity to operate.

"WEB APPLICATION" means an Application that is deployed to a Server and has multiple users accessing it remotely.

EVALUATION LICENSE

Dynamsoft grants Licensee a limited, non-exclusive, non-transferable license to use the SOFTWARE for evaluation purposes for 30 days. An Evaluation License does NOT grant you the right to distribute the SOFTWARE.

GRANT OF LICENSE FOR DESKTOP APPLICATION

DEVELOPER LICENSE

For each Developer License of the SOFTWARE purchased by Licensee, Dynamsoft grants Licensee a non-exclusive, non-transferable, perpetual, worldwide license for one (1) named programmer to install the SOFTWARE on a personal computer and use the SOFTWARE, including its documentation and sample code, in the development of One Application. Licensee may install the SOFTWARE on one additional development computer, such as a laptop computer, for use by Licensee's named programmer when such person's primary development computer is not available.

The Developer License is on a per Application per named programmer basis.

SITE LICENSE

Dynamsoft grants you a limited, non-exclusive, non-transferable license to use the SOFTWARE and the accompanying materials for the purpose of development of one Application by an unlimited number of developers, by a single company, at a single geographic location as designated at the time of purchase. Additional licensing is required to install or use the SOFTWARE by developers at other locations, and/or in other companies. You must not make the SOFTWARE available through any server or file sharing apparatus for use on more computers or by more users than is set out in this clause.

Royalty free for desktop application deployment.

GRANT OF LICENSE FOR WEB APPLICATIONS

Development

For development purpose, You can use the Evaluation License key. After purchasing the Server License, you can use the Server License key.

Deployment

Server License is a Deployment License which is required to deploy one Application that uses the SOFTWARE to one server.

The Server License is on a per-application, per-server basis. Types of Servers:

Production Server - Each production server requires a Server License.
Non-production Server - Development servers, testing servers, and staging servers are all considered non-production servers. Each non-production Server requires a Non-Production Server License.
Yearly License

The Software can also be licensed on a per Application per year basis. With a Yearly License, You can deploy one Application to an unlimited number of Servers within the coverage period.

Renewal: The Yearly License will be valid for one year following the license order date. Thereafter, You can extend the validity of the Yearly License additional one year periods (each a "Renewal Term").

Effect of Termination: Upon the expiration of Yearly License, all rights of You granted under this Agreement (including but not limited to, the rights to use, resell, distribute, sublicense and/or provide access to the Software) shall terminate, and, You shall immediately: (a) cease incorporating the Software into the Application; (b) cease use of the Software (in any form, including partial copies in its possession or under its control), and (c) destroy all copies of the Software.

More flexible licensing options can be discussed with [email protected].

GRANT OF LICENSE FOR MOBILE APP

The license of Mobile Edition

Includes one developer license
is Limited to one developed App
Covers both Android and iOS Apps
Allows for distribution of a single application on unlimited devices through Android's Google play store and Apple's iTunes store
RESTRICTIONS

Your product is targeted to end users. The end user application you develop using the SOFTWARE must not be another development tool and/or SDK.

Users of end user applications you develop using the SOFTWARE may not further use the SOFTWARE, in whole or in part, for software development, copying or distribution. You must enforce this restriction in a separate agreement between You and the end user of your applications.

Evaluation License holders are granted the use of only one copy of the SOFTWARE per Evaluation License. The SOFTWARE is "in-use" on a computer when it is loaded into temporary memory (i.e. RAM) or installed into the storage device of that computer.

You may make a single copy of the SOFTWARE for backup purposes only.

You are not permitted to directly or indirectly expose the properties and methods of the SOFTWARE.

All rights reserved. You may not use, copy, modify, reverse engineer, decompile, disassemble, sell, transfer, hire, lend or otherwise distribute the SOFTWARE or any accompanying materials in whole or in part, except as expressly provided for in this agreement.

OWNERSHIP

Dynamsoft shall remain the owner of the SOFTWARE.

This license does not confer any ownership rights to the licensee.

WARRANTIES AND DISCLAIMERS

THIS SOFTWARE AND THE ACCOMPANYING FILES ARE SOLD "AS IS" WITHOUT WARRANTY OF ANY KIND EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. ANY USE BY YOU OF THE SOFTWARE IS AT YOUR OWN RISK.

NO LIABILITY FOR CONSEQUENTIAL DAMAGES. UNDER NO CIRCUMSTANCE SHALL DYNAMSOFT BE LIABLE FOR ANY DAMAGES WHATSOEVER ARISING FROM THE USING OR INABILITY TO USE DYNAMSOFT PRODUCTS.

APPLICABLE LAWS

This agreement shall be governed by the laws of Canada.

tools\net20\Dynamsoft.BarcodeReader.dll

md5: 19BCE6FA1BCF2D4E56465BD404C3AD00 | sha1: D70ADA197549229EC6B124635D1119CCA203DDA4 | sha256: FCD06EC24DA44CA3148B2DE8FE656DADFC40839534EDA1DAB942EECDCCF4E3FF | sha512: 329FDC6C907B4D467CA556AFD39ECDC7042508654AB5ECB6598B77432F15F3FEB7079C92C878CB6FB43FFDD786987B45E45C1279E16507F3B3BCF54914C98430

tools\net20\Dynamsoft.BarcodeReader.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Dynamsoft.BarcodeReader</name>
    </assembly>
    <members>
        <member name="T:Dynamsoft.Barcode.BarcodeReader">
            <summary>
             Defines a class provides functions for working with extracting barcode data.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.#ctor">
            <summary>
             Create an instance of BarcodeReader with default setting.
            </summary>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.#ctor(System.String)">
            <summary>
             Create an instance of BarcodeReader and set license keys.
            </summary>
            <param name="strLicenseKey">
             The license keys to be set.
            </param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeFile(System.String)">
            <summary>
             Read barcodes from a file with full path.
            </summary>
            <param name="strFileName">
             The local path of the file.
            </param>
            <returns>
             All barcodes have been read. If no barcodes are read, null is returned.
            </returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeBitmap(System.Drawing.Bitmap)">
            <summary>
             Read barcodes from an image. Only decode the current page when handling multi-page images.
            </summary>
            <param name="bitmap">
             The image to be decoded.
            </param>
            <returns>
             All barcodes have been read. If no barcodes are read, null is returned.
            </returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeBuffer(System.Byte[],System.Int32,System.Int32,System.Int32,Dynamsoft.Barcode.ImagePixelFormat)">
            <summary>
             Read barcodes from raw buffer.
            </summary>
            <param name="bytBuffer">
             The image raw buffer.
            </param>
            <param name="iWidth">
             The width of image buffer.
            </param>
            <param name="iHeight">
             The height of image buffer.
            </param>
            <param name="iStride">
             The stride width (also called scan width) of the image buffer.
            </param>
            <param name="emFormat">
             The pixel format of image buffer.
            </param>
            <returns>
             All barcodes have been read. If no barcodes are read, null is returned.
            </returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeStream(System.Byte[])">
            <summary>
            Read barcodes from the byte array of a file.
            </summary>
            <param name="bytFileStream">The byte array of a file.</param>
            <returns>All barcodes have been read. If no barcodes are read, null is returned.</returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeBase64String(System.String)">
            <summary>
            Read barcodes from the base64 encoded string of a file.
            </summary>
            <param name="strBase64">The base64 encoded string of a file.</param>
            <returns>All barcodes have been read. If no barcodes are read, null is returned.</returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddPage(System.Int32)">
            <summary>
            Adds a page of a file(tiff or pdf format) to the selection for the barcode search.
            </summary>
            <param name="iPage">The page of a file.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetPageCount">
            <summary>
            Returns the number of pages in the selection.
            </summary>
            <returns>The number of pages in the selection</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetPage(System.Int32,System.Int32@)">
            <summary>
            Get a page number by the index of pages array.
            </summary>
            <param name="iIndex">The index of pages array.</param>
            <param name="iPage">The page number corresponding to the index.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllPages">
            <summary>
            Clears all pages from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddRegion(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
            <summary>
            Adds an area of the image to the selection for barcode recognition.
            </summary>
            <param name="iLeft">The left-most coordinate of the area.</param>
            <param name="iTop">The top-most coordinate of the area.</param>
            <param name="iRight">The right-most coordinate of the area.</param>
            <param name="iBottom">The bottom-most coordinate of the area.</param>
            <param name="bByPercentage">Indicates the coordinate is measured by percentage or not.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddRegion(Dynamsoft.Barcode.ScanRegionSide,System.Int32)">
            <summary>
            Adds an area of the image to the selection for barcode recognition.
            </summary>
            <param name="emSide">The type of the area.</param>
            <param name="iPercentage">The percentage measured from region side based on the parameter "emSide".</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetRegionCount">
            <summary>
            Returns the number of regions in the selection.
            </summary>
            <returns>The number of regions in the selection</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetRegion(System.Int32,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Boolean@)">
            <summary>
            Get a region by the index of regions array.
            </summary>
            <param name="iIndex">The index of regions array.</param>
            <param name="piLeft">The left-most coordinate of the area.</param>
            <param name="piTop">The top-most coordinate of the area.</param>
            <param name="piRight">The right-most coordinate of the area.</param>
            <param name="piBottom">The bottom-most coordinate of the area.</param>
            <param name="pbByPercentage">Indicates the coordinate is measured by percentage or not.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllRegions">
            <summary>
            Clears all regions from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddWidthRange(System.Int32,System.Int32)">
            <summary>
            Adds a range of barcode widths (in pixels) to the selection for the barcode search.
            </summary>
            <param name="iMinWidth">The minimal width of the searching barcode.</param>
            <param name="iMaxWidth">The maximal width of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetWidthRangeCount">
            <summary>
            Returns the number of barcode width ranges in the selection.
            </summary>
            <returns>The number of barcode width ranges in the selection.</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetWidthRange(System.Int32,System.Int32@,System.Int32@)">
            <summary>
            Get a width range by the index of width ranges array.
            </summary>
            <param name="iIndex">The index of width ranges array.</param>
            <param name="piMinWidth">The minimal width of the searching barcode.</param>
            <param name="piMaxWidth">The maximal width of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllWidthRanges">
            <summary>
            Clears all width ranges from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddHeightRange(System.Int32,System.Int32)">
            <summary>
            Adds a range of barcode heights (in pixels) to the selection for the barcode search.
            </summary>
            <param name="iMinHeight">The minimal height of the searching barcode.</param>
            <param name="iMaxHeight">The maximal height of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetHeightRangeCount">
            <summary>
            Returns the number of barcode height ranges in the selection.
            </summary>
            <returns>The number of barcode height ranges in the selection.</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetHeightRange(System.Int32,System.Int32@,System.Int32@)">
            <summary>
            Gets a height range by the index of height ranges array.
            </summary>
            <param name="iIndex">The index of height ranges array.</param>
            <param name="piMinHeight">The minimal height of the searching barcode.</param>
            <param name="piMaxHeight">The maximal height of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllHeightRanges">
            <summary>
            Clears all height ranges from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddModuleSizeRange(System.Int32,System.Int32)">
            <summary>
            Adds a range of barcode module size in pixels (the minimum bar width) to the selection for the barcode search.
            </summary>
            <param name="iMinModuleSize">The minimal module size of the searching barcode.</param>
            <param name="iMaxModuleSize">The maximal module size of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetModuleSizeRangeCount">
            <summary>
            Returns the number of barcode module size ranges in the selection.
            </summary>
            <returns>The number of barcode module size ranges in the selection.</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetModuleSizeRange(System.Int32,System.Int32@,System.Int32@)">
            <summary>
            Gets a module size range by the index of module size ranges array.
            </summary>
            <param name="iIndex">The index of module size ranges array.</param>
            <param name="piMinModuleSize">The minimal module size of the searching barcode.</param>
            <param name="piMaxModuleSize">The maximal module size of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllModuleSizeRanges">
            <summary>
            Clears all module size ranges from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddAngleRange(System.Int32,System.Int32)">
            <summary>
            Adds a range of angles (in degrees) to the selection for the barcode search.
            </summary>
            <param name="iFromAngle">The lower bound of angle range.</param>
            <param name="iToAngle">The upper bound of angle range.</param>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddAngle(Dynamsoft.Barcode.BarcodeOrientationType)">
            <summary>
            Adds an orientation type of barcodes to the selection for the barcode search.
            </summary>
            <param name="emType">The orientation type of barcodes for searching.</param>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetAngleRangeCount">
            <summary>
            Returns the number of angle ranges in the selection.
            </summary>
            <returns>The number of angle ranges in the selection.</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetAngleRange(System.Int32,System.Int32@,System.Int32@)">
            <summary>
            Gets an angle range by the index of angle ranges array.
            </summary>
            <param name="iIndex">The index of angle ranges array.</param>
            <param name="piFromAngle">The lower bound of angle range.</param>
            <param name="piToAngle">The upper bound of angle range.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllAngleRanges">
            <summary>
            Clears all angle ranges from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.LoadSetting(System.String)">
            <summary>
            Loads the settings to be used in recognizing barcodes from a JSON string.
            </summary>
            <param name="strJsonSetting">The JSON string of barcode recognizing setting.</param>
            <returns>If the input is not a valid json format string, return false. </returns>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReader.LicenseKeys">
            <summary>
            Get or set the license key string.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReader.ReaderOptions">
            <summary>
             Get or set the reading options, such as max number and type of barcode to read.
            </summary>
            <remarks>
             With default reading options, BarcodeReader will decode all format and all barcodes.
            </remarks>
        </member>
        <member name="T:Dynamsoft.Barcode.ErrorCode">
            <summary>
             Defines the error code of Dynamsoft.BarcodeReader.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_SUCCESS">
            <summary>
             Successful.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_UNKNOWN">
            <summary>
             Unknown error.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_NOMEMORY">
            <summary>
             Not enough memory to perform the operation.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_NULL_REFERENCE">
            <summary>
             Null pointer.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_LICENSE_INVALID">
            <summary>
             The license is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_LICENSE_EXPIRED">
            <summary>
             The license expired.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_FILE_NOT_FOUND">
            <summary>
             The file to decode is not found.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_FILETYPE_NOT_SUPPORT">
            <summary>
             The file type is not supported.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_BPP_NOT_SUPPORT">
            <summary>
             The BPP(Bits per pixel) is not supported.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_INDEX_INVALID">
            <summary>
             The index is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_BARCODE_FORMAT_INVALID">
            <summary>
             The barcode format is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_CUSTOM_REGION_INVALID">
            <summary>
             Input region parameter is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_MAX_BARCODE_NUMBER_INVALID">
            <summary>
             The maximum barcode number is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_IMAGE_READ_FAIL">
            <summary>
             Failed to read the image.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_TIFF_READ_FAIL">
            <summary>
             Failed to read the TIFF image.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_QR_LICENSE_INVALID">
            <summary>
             You do not have a valid QR Code license.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_1D_LICENSE_INVALID">
            <summary>
             You do not have a valid 1D Barcode license.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_INVALID_DIB_BUFFER">
            <summary>
             The DIB(Device-independent bitmaps) buffer is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_PDF417_LICENSE_INVALID">
            <summary>
             You do not have a valid PDF417 barcode license.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_DATAMATRIX_LICENSE_INVALID">
            <summary>
             You do not have a valid DATAMATRIX barcode license.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_PDF_READ_FAIL">
            <summary>
            Failed to read the PDF file.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_PDF_DLL_MISS">
            <summary>
            The PDF DLL is missing.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_PAGE_NUMBER_INVALID">
            <summary>
            The page number is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_CUSTOM_SIZE_INVALID">
            <summary>
            The custom size is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_CUSTOM_MODULESIZE_INVALID">
            <summary>
            The custom module size is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_RECOGNITION_TIMEOUT">
            <summary>
            Recognition timeout.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_SYSTEM_EXCEPTION">
            <summary>
             The system exceptions.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeReaderException">
            <summary>
             The exception of Dynamsoft.BarcodeReader.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReaderException.#ctor">
            <summary>
             Create an instance of BarcodeReaderException.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReaderException.Code">
            <summary>
             Get or set the error code.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReaderException.Message">
            <summary>
             Get the message that describes the current exception.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReaderException.StackTrace">
            <summary>
             Get the string representation of the frames on the call stack at the time the current exception was thrown.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeFormat">
            <summary>
             Describes the type of the barcode.
            </summary>
            <remarks>
             All the formats can be combined, such as BarcodeFormat.CODE_39 | BarcodeFormat.CODE_128.
            </remarks>
        </member>
        <member name="T:Dynamsoft.Barcode.ImageCaptureDevice">
            <summary>
             Describes the image capture device.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeColorMode">
            <summary>
             Describes the barcode color mode.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.ScanRegionSide">
            <summary>
             Describes the barcode region side type.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeOrientationType">
            <summary>
             Describes the barcode orientation type.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeTextEncoding">
            <summary>
             Describes the barcode text encoding.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.ImagePixelFormat">
            <summary>
             Describes the image pixel format.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.ReaderOptions">
            <summary>
             The options of decoding, such as the type and number of barcodes.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.ReaderOptions.#ctor">
            <summary>
             Create an instance of ReaderOptions with default setting.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.ImageCaptureDevice">
            <summary>
             Get or set where is the image captured.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.BarcodeColorMode">
            <summary>
             Get or set the color for barcodes search
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.BarcodeTextEncoding">
            <summary>
             Get or set barcode text encoding
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.TimeoutPerPage">
            <summary>
             Get or set maximum time to read barcode per page.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.UseOneDDeblur">
            <summary>
             Get or set a value that indicating whether the deblur workflow for OneD is enabed.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.ReturnUnrecognizedBarcode">
            <summary>
             Get or set a value that indicating whether the unrecognized barcode should be returned.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.MaxBarcodesToReadPerPage">
            <summary>
             Get or set maximum number to read barcode per page.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.BarcodeFormats">
            <summary>
             Get or set type to read barcode.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeResult">
            <summary>
             Store the barcode type, contents, boundary, vertices, etc.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.Angle">
            <summary>
             Get the barcode angle.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.ModuleSize">
            <summary>
             Get the barcode module size.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.IsUnrecognized">
            <summary>
             Get a value that indicating whether the barcode is recognized or not.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.BarcodeFormat">
            <summary>
             Get the barcode type.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.BarcodeText">
            <summary>
             Get the barcode string.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.BarcodeData">
            <summary>
             Get the barcode data as bytes.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.BoundingRect">
            <summary>
             Get the barcode boundary.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.ResultPoints">
            <summary>
             Get the coordinates of the barcode vertices.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.PageNumber">
            <summary>
             Get the page number that the barcode located in.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.Resource">
            <summary>
              A strongly-typed resource class, for looking up localized strings, etc.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.ResourceManager">
            <summary>
              Returns the cached ResourceManager instance used by this class.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.Culture">
            <summary>
              Overrides the current thread's CurrentUICulture property for all
              resource lookups using this strongly typed resource class.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.DynamicPdf">
            <summary>
              Looks up a localized resource of type System.Byte[].
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.DynamicPdfx64">
            <summary>
              Looks up a localized resource of type System.Byte[].
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.DynamsoftBarcodeReaderx64">
            <summary>
              Looks up a localized resource of type System.Byte[].
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.DynamsoftBarcodeReaderx86">
            <summary>
              Looks up a localized resource of type System.Byte[].
            </summary>
        </member>
    </members>
</doc>

tools\net40\Dynamsoft.BarcodeReader.dll

md5: 21BDF5FB46DDC72EA6DC46399FA14F09 | sha1: EE355273D15C5AA29D3F91846A33D81F284E55D2 | sha256: 6E71830A2033DB36811CE6DFD9B35F67CAC33DC971AF23749B9742AD814BAE31 | sha512: 52D8C722997A51929EF308ECDC58EA6D90331957876CF3570F8771BEAC39E00D0961623D03A1982C002B0F95758CD167F09D533D028EAD4A029E70B97B5A0DAA

tools\net40\Dynamsoft.BarcodeReader.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Dynamsoft.BarcodeReader</name>
    </assembly>
    <members>
        <member name="T:Dynamsoft.Barcode.BarcodeReader">
            <summary>
             Defines a class provides functions for working with extracting barcode data.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.#ctor">
            <summary>
             Create an instance of BarcodeReader with default setting.
            </summary>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.#ctor(System.String)">
            <summary>
             Create an instance of BarcodeReader and set license keys.
            </summary>
            <param name="strLicenseKey">
             The license keys to be set.
            </param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeFile(System.String)">
            <summary>
             Read barcodes from a file with full path.
            </summary>
            <param name="strFileName">
             The local path of the file.
            </param>
            <returns>
             All barcodes have been read. If no barcodes are read, null is returned.
            </returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeBitmap(System.Drawing.Bitmap)">
            <summary>
             Read barcodes from an image. Only decode the current page when handling multi-page images.
            </summary>
            <param name="bitmap">
             The image to be decoded.
            </param>
            <returns>
             All barcodes have been read. If no barcodes are read, null is returned.
            </returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeBuffer(System.Byte[],System.Int32,System.Int32,System.Int32,Dynamsoft.Barcode.ImagePixelFormat)">
            <summary>
             Read barcodes from raw buffer.
            </summary>
            <param name="bytBuffer">
             The image raw buffer.
            </param>
            <param name="iWidth">
             The width of image buffer.
            </param>
            <param name="iHeight">
             The height of image buffer.
            </param>
            <param name="iStride">
             The stride width (also called scan width) of the image buffer.
            </param>
            <param name="emFormat">
             The pixel format of image buffer.
            </param>
            <returns>
             All barcodes have been read. If no barcodes are read, null is returned.
            </returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            	The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeStream(System.Byte[])">
            <summary>
            Read barcodes from the byte array of a file.
            </summary>
            <param name="bytFileStream">The byte array of a file.</param>
            <returns>All barcodes have been read. If no barcodes are read, null is returned.</returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.DecodeBase64String(System.String)">
            <summary>
            Read barcodes from the base64 encoded string of a file.
            </summary>
            <param name="strBase64">The base64 encoded string of a file.</param>
            <returns>All barcodes have been read. If no barcodes are read, null is returned.</returns>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddPage(System.Int32)">
            <summary>
            Adds a page of a file(tiff or pdf format) to the selection for the barcode search.
            </summary>
            <param name="iPage">The page of a file.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetPageCount">
            <summary>
            Returns the number of pages in the selection.
            </summary>
            <returns>The number of pages in the selection</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetPage(System.Int32,System.Int32@)">
            <summary>
            Get a page number by the index of pages array.
            </summary>
            <param name="iIndex">The index of pages array.</param>
            <param name="iPage">The page number corresponding to the index.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllPages">
            <summary>
            Clears all pages from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddRegion(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
            <summary>
            Adds an area of the image to the selection for barcode recognition.
            </summary>
            <param name="iLeft">The left-most coordinate of the area.</param>
            <param name="iTop">The top-most coordinate of the area.</param>
            <param name="iRight">The right-most coordinate of the area.</param>
            <param name="iBottom">The bottom-most coordinate of the area.</param>
            <param name="bByPercentage">Indicates the coordinate is measured by percentage or not.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddRegion(Dynamsoft.Barcode.ScanRegionSide,System.Int32)">
            <summary>
            Adds an area of the image to the selection for barcode recognition.
            </summary>
            <param name="emSide">The type of the area.</param>
            <param name="iPercentage">The percentage measured from region side based on the parameter "emSide".</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetRegionCount">
            <summary>
            Returns the number of regions in the selection.
            </summary>
            <returns>The number of regions in the selection</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetRegion(System.Int32,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Boolean@)">
            <summary>
            Get a region by the index of regions array.
            </summary>
            <param name="iIndex">The index of regions array.</param>
            <param name="piLeft">The left-most coordinate of the area.</param>
            <param name="piTop">The top-most coordinate of the area.</param>
            <param name="piRight">The right-most coordinate of the area.</param>
            <param name="piBottom">The bottom-most coordinate of the area.</param>
            <param name="pbByPercentage">Indicates the coordinate is measured by percentage or not.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllRegions">
            <summary>
            Clears all regions from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddWidthRange(System.Int32,System.Int32)">
            <summary>
            Adds a range of barcode widths (in pixels) to the selection for the barcode search.
            </summary>
            <param name="iMinWidth">The minimal width of the searching barcode.</param>
            <param name="iMaxWidth">The maximal width of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetWidthRangeCount">
            <summary>
            Returns the number of barcode width ranges in the selection.
            </summary>
            <returns>The number of barcode width ranges in the selection.</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetWidthRange(System.Int32,System.Int32@,System.Int32@)">
            <summary>
            Get a width range by the index of width ranges array.
            </summary>
            <param name="iIndex">The index of width ranges array.</param>
            <param name="piMinWidth">The minimal width of the searching barcode.</param>
            <param name="piMaxWidth">The maximal width of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllWidthRanges">
            <summary>
            Clears all width ranges from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddHeightRange(System.Int32,System.Int32)">
            <summary>
            Adds a range of barcode heights (in pixels) to the selection for the barcode search.
            </summary>
            <param name="iMinHeight">The minimal height of the searching barcode.</param>
            <param name="iMaxHeight">The maximal height of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetHeightRangeCount">
            <summary>
            Returns the number of barcode height ranges in the selection.
            </summary>
            <returns>The number of barcode height ranges in the selection.</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetHeightRange(System.Int32,System.Int32@,System.Int32@)">
            <summary>
            Gets a height range by the index of height ranges array.
            </summary>
            <param name="iIndex">The index of height ranges array.</param>
            <param name="piMinHeight">The minimal height of the searching barcode.</param>
            <param name="piMaxHeight">The maximal height of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllHeightRanges">
            <summary>
            Clears all height ranges from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddModuleSizeRange(System.Int32,System.Int32)">
            <summary>
            Adds a range of barcode module size in pixels (the minimum bar width) to the selection for the barcode search.
            </summary>
            <param name="iMinModuleSize">The minimal module size of the searching barcode.</param>
            <param name="iMaxModuleSize">The maximal module size of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetModuleSizeRangeCount">
            <summary>
            Returns the number of barcode module size ranges in the selection.
            </summary>
            <returns>The number of barcode module size ranges in the selection.</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetModuleSizeRange(System.Int32,System.Int32@,System.Int32@)">
            <summary>
            Gets a module size range by the index of module size ranges array.
            </summary>
            <param name="iIndex">The index of module size ranges array.</param>
            <param name="piMinModuleSize">The minimal module size of the searching barcode.</param>
            <param name="piMaxModuleSize">The maximal module size of the searching barcode.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllModuleSizeRanges">
            <summary>
            Clears all module size ranges from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddAngleRange(System.Int32,System.Int32)">
            <summary>
            Adds a range of angles (in degrees) to the selection for the barcode search.
            </summary>
            <param name="iFromAngle">The lower bound of angle range.</param>
            <param name="iToAngle">The upper bound of angle range.</param>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.AddAngle(Dynamsoft.Barcode.BarcodeOrientationType)">
            <summary>
            Adds an orientation type of barcodes to the selection for the barcode search.
            </summary>
            <param name="emType">The orientation type of barcodes for searching.</param>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetAngleRangeCount">
            <summary>
            Returns the number of angle ranges in the selection.
            </summary>
            <returns>The number of angle ranges in the selection.</returns>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.GetAngleRange(System.Int32,System.Int32@,System.Int32@)">
            <summary>
            Gets an angle range by the index of angle ranges array.
            </summary>
            <param name="iIndex">The index of angle ranges array.</param>
            <param name="piFromAngle">The lower bound of angle range.</param>
            <param name="piToAngle">The upper bound of angle range.</param>
            <exception cref="T:Dynamsoft.Barcode.BarcodeReaderException">
            The exception thrown by Dynamsoft Barcode Reader.
            </exception>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.ClearAllAngleRanges">
            <summary>
            Clears all angle ranges from the selection.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReader.LoadSetting(System.String)">
            <summary>
            Loads the settings to be used in recognizing barcodes from a JSON string.
            </summary>
            <param name="strJsonSetting">The JSON string of barcode recognizing setting.</param>
            <returns>If the input is not a valid json format string, return false. </returns>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReader.LicenseKeys">
            <summary>
            Get or set the license key string.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReader.ReaderOptions">
            <summary>
             Get or set the reading options, such as max number and type of barcode to read.
            </summary>
            <remarks>
             With default reading options, BarcodeReader will decode all format and all barcodes.
            </remarks>
        </member>
        <member name="T:Dynamsoft.Barcode.ErrorCode">
            <summary>
             Defines the error code of Dynamsoft.BarcodeReader.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_SUCCESS">
            <summary>
             Successful.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_UNKNOWN">
            <summary>
             Unknown error.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_NOMEMORY">
            <summary>
             Not enough memory to perform the operation.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_NULL_REFERENCE">
            <summary>
             Null pointer.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_LICENSE_INVALID">
            <summary>
             The license is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_LICENSE_EXPIRED">
            <summary>
             The license expired.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_FILE_NOT_FOUND">
            <summary>
             The file to decode is not found.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_FILETYPE_NOT_SUPPORT">
            <summary>
             The file type is not supported.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_BPP_NOT_SUPPORT">
            <summary>
             The BPP(Bits per pixel) is not supported.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_INDEX_INVALID">
            <summary>
             The index is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_BARCODE_FORMAT_INVALID">
            <summary>
             The barcode format is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_CUSTOM_REGION_INVALID">
            <summary>
             Input region parameter is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_MAX_BARCODE_NUMBER_INVALID">
            <summary>
             The maximum barcode number is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_IMAGE_READ_FAIL">
            <summary>
             Failed to read the image.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_TIFF_READ_FAIL">
            <summary>
             Failed to read the TIFF image.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_QR_LICENSE_INVALID">
            <summary>
             You do not have a valid QR Code license.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_1D_LICENSE_INVALID">
            <summary>
             You do not have a valid 1D Barcode license.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_INVALID_DIB_BUFFER">
            <summary>
             The DIB(Device-independent bitmaps) buffer is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_PDF417_LICENSE_INVALID">
            <summary>
             You do not have a valid PDF417 barcode license.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_DATAMATRIX_LICENSE_INVALID">
            <summary>
             You do not have a valid DATAMATRIX barcode license.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_PDF_READ_FAIL">
            <summary>
            Failed to read the PDF file.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_PDF_DLL_MISS">
            <summary>
            The PDF DLL is missing.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_PAGE_NUMBER_INVALID">
            <summary>
            The page number is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_CUSTOM_SIZE_INVALID">
            <summary>
            The custom size is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_CUSTOM_MODULESIZE_INVALID">
            <summary>
            The custom module size is invalid.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_RECOGNITION_TIMEOUT">
            <summary>
            Recognition timeout.
            </summary>
        </member>
        <member name="F:Dynamsoft.Barcode.ErrorCode.DBR_SYSTEM_EXCEPTION">
            <summary>
             The system exceptions.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeReaderException">
            <summary>
             The exception of Dynamsoft.BarcodeReader.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.BarcodeReaderException.#ctor">
            <summary>
             Create an instance of BarcodeReaderException.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReaderException.Code">
            <summary>
             Get or set the error code.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReaderException.Message">
            <summary>
             Get the message that describes the current exception.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeReaderException.StackTrace">
            <summary>
             Get the string representation of the frames on the call stack at the time the current exception was thrown.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeFormat">
            <summary>
             Describes the type of the barcode.
            </summary>
            <remarks>
             All the formats can be combined, such as BarcodeFormat.CODE_39 | BarcodeFormat.CODE_128.
            </remarks>
        </member>
        <member name="T:Dynamsoft.Barcode.ImageCaptureDevice">
            <summary>
             Describes the image capture device.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeColorMode">
            <summary>
             Describes the barcode color mode.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.ScanRegionSide">
            <summary>
             Describes the barcode region side type.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeOrientationType">
            <summary>
             Describes the barcode orientation type.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeTextEncoding">
            <summary>
             Describes the barcode text encoding.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.ImagePixelFormat">
            <summary>
             Describes the image pixel format.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.ReaderOptions">
            <summary>
             The options of decoding, such as the type and number of barcodes.
            </summary>
        </member>
        <member name="M:Dynamsoft.Barcode.ReaderOptions.#ctor">
            <summary>
             Create an instance of ReaderOptions with default setting.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.ImageCaptureDevice">
            <summary>
             Get or set where is the image captured.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.BarcodeColorMode">
            <summary>
             Get or set the color for barcodes search
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.BarcodeTextEncoding">
            <summary>
             Get or set barcode text encoding
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.TimeoutPerPage">
            <summary>
             Get or set maximum time to read barcode per page.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.UseOneDDeblur">
            <summary>
             Get or set a value that indicating whether the deblur workflow for OneD is enabed.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.ReturnUnrecognizedBarcode">
            <summary>
             Get or set a value that indicating whether the unrecognized barcode should be returned.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.MaxBarcodesToReadPerPage">
            <summary>
             Get or set maximum number to read barcode per page.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.ReaderOptions.BarcodeFormats">
            <summary>
             Get or set type to read barcode.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.BarcodeResult">
            <summary>
             Store the barcode type, contents, boundary, vertices, etc.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.Angle">
            <summary>
             Get the barcode angle.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.ModuleSize">
            <summary>
             Get the barcode module size.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.IsUnrecognized">
            <summary>
             Get a value that indicating whether the barcode is recognized or not.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.BarcodeFormat">
            <summary>
             Get the barcode type.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.BarcodeText">
            <summary>
             Get the barcode string.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.BarcodeData">
            <summary>
             Get the barcode data as bytes.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.BoundingRect">
            <summary>
             Get the barcode boundary.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.ResultPoints">
            <summary>
             Get the coordinates of the barcode vertices.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.BarcodeResult.PageNumber">
            <summary>
             Get the page number that the barcode located in.
            </summary>
        </member>
        <member name="T:Dynamsoft.Barcode.Resource">
            <summary>
              A strongly-typed resource class, for looking up localized strings, etc.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.ResourceManager">
            <summary>
              Returns the cached ResourceManager instance used by this class.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.Culture">
            <summary>
              Overrides the current thread's CurrentUICulture property for all
              resource lookups using this strongly typed resource class.
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.DynamicPdf">
            <summary>
              Looks up a localized resource of type System.Byte[].
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.DynamicPdfx64">
            <summary>
              Looks up a localized resource of type System.Byte[].
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.DynamsoftBarcodeReaderx64">
            <summary>
              Looks up a localized resource of type System.Byte[].
            </summary>
        </member>
        <member name="P:Dynamsoft.Barcode.Resource.DynamsoftBarcodeReaderx86">
            <summary>
              Looks up a localized resource of type System.Byte[].
            </summary>
        </member>
    </members>
</doc>

tools\VERIFICATION.txt

VERIFICATION
Verification is intended to assist the Chocolatey moderators and community
in verifying that this package's contents are trustworthy.

This package is published by the Dynamsoft Barcode Reader project.

Virus Scan Results

Dynamsoft.BarcodeReader.dll (fcd06ec24da4) - ## / 64
Dynamsoft.BarcodeReader.dll (6e71830a2033) - ## / 65
dbr.5.2.0.nupkg (f4f40438d401) - ## / 62

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version History

Add to Builder	Version	Downloads	Last Updated	Status
	Dynamsoft Barcode Reader 5.2.0	1329	Thursday, November 30, 2017	Approved

Dynamsoft

Dependencies

This package has no dependencies.

Discussion for the Dynamsoft Barcode Reader Package

Ground Rules:

This discussion is only about Dynamsoft Barcode Reader and the Dynamsoft Barcode Reader package. If you have feedback for Chocolatey, please contact the Google Group.
This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
Tell us what you love about the package or Dynamsoft Barcode Reader, or tell us what needs improvement.
Share your experiences with the package, or extra configuration or gotchas that you've found.
If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

Resources

Events

Courses

1,498

1,329

30 Nov 2017

Dynamsoft Barcode Reader

Dynamsoft Barcode Reader 5.2.0

Some Checks Have Failed or Are Not Yet Complete

Deployment Method: Individual Install, Upgrade, & Uninstall

Deployment Method:

1. Enter Your Internal Repository Url

2. Setup Your Environment

1. Ensure you are set for organizational deployment

2. Get the package into your environment

3. Copy Your Script

4. If applicable - Chocolatey configuration/installation

Ground Rules: