Skip to content

Latest commit

 

History

History
114 lines (88 loc) · 2.56 KB

div.md

File metadata and controls

114 lines (88 loc) · 2.56 KB
Raw
description ms.date ms.topic title
Reference for the 'div' DSC configuration document function
03/19/2024
reference
div

div

Synopsis

Returns the quotient for the division of two integers.

Syntax

div(<operands>)

Description

The div() function returns the quotient for the division of two integers. If the result of the division isn't an integer, the function returns the value of the division rounded down to the nearest integer.

Examples

Example 1 - Divide two integers

This example document shows how you can use the div() function to return the division of two integers.

# div.example.1.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Dividing integers
  type: Test/Echo
  properties:
    output: "[div(6,3)]"
dsc config get --document div.example.1.dsc.config.yaml config get
results:
- name: Dividing integers
  type: Test/Echo
  result:
    actualState:
      output: 2
messages: []
hadErrors: false

Example 2 - Divide output of nested functions

This example document shows how you can use the div() function to divide the outputs of nested configuration functions. Because the outputs are 14 and 5, the final result is 2. DSC returns the full integer value without the remainder. It doesn't round the result up to 3.

# div.example.2.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Dividing nested functions
  type: Test/Echo
  properties:
    output: "[div(mul(7,2), add(4,1))]"
dsc config get --document div.example.2.dsc.config.yaml
results:
- name: Dividing nested functions
  type: Test/Echo
  result:
    actualState:
      output: 2
messages: []
hadErrors: false

Parameters

operands

The div() function expects exactly two integers as input. The operands can be either an integer or the output of any configuration function that returns an integer. The function divides the first operand by the second operand. Separate the operands with a comma (,).

Type:         integer
Required:     true
MinimumCount: 2
MaximumCount: 2

Output

The div() function returns an integer value representing the division of the first operand by the second operand. If the division result isn't an integer, the function returns the integer value of the result without the fractional remainder.

Type: integer