en-US/Get-CPR-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CPR</command:name> <command:verb>Get</command:verb> <command:noun>CPR</command:noun> <maml:description> <maml:para>Generates a random Danish CPR number.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-CPR` function generates a random Danish CPR number based on optional parameters such as age, gender, and validation rules. It can also format the CPR number with or without a hyphen.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CPR</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>age</maml:name> <maml:description> <maml:para>Specifies the age for the generated CPR number.</maml:para> <maml:para>- Type : `int` - Required : No - Position : 1 - Default value : Random age between 0 and 100 - Accept pipeline input : No</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>gender</maml:name> <maml:description> <maml:para>Specifies the gender for the generated CPR number.</maml:para> <maml:para>- Type : `Gender` (Male or Female) - Required : No - Position : 2 - Default value : Random gender - Accept pipeline input : No</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>useModuloValidation</maml:name> <maml:description> <maml:para>Ensures the generated CPR number passes modulo 11 validation.</maml:para> <maml:para>- Type : `switch` - Required : No - Position : Named - Default value : False - Accept pipeline input : No</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>omitHyphen</maml:name> <maml:description> <maml:para>Omits the hyphen in the generated CPR number.</maml:para> <maml:para>- Type : `switch` - Required : No - Position : Named - Default value : False - Accept pipeline input : No</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>This function is intended for use in test environments and should not be used with real CPR numbers in production systems.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Generate a random CPR number -----------</maml:title> <dev:code>Get-CPR</dev:code> <dev:remarks> <maml:para>Generates a random CPR number.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--- Example 2: Generate a CPR number for a 25-year-old male ---</maml:title> <dev:code>Get-CPR -age 25 -gender Male</dev:code> <dev:remarks> <maml:para>Generates a CPR number for a 25-year-old male.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 3: Generate a CPR number with modulo 11 validation --</maml:title> <dev:code>Get-CPR -useModuloValidation</dev:code> <dev:remarks> <maml:para>Generates a CPR number that passes modulo 11 validation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 4: Generate a CPR number without a hyphen ------</maml:title> <dev:code>Get-CPR -omitHyphen</dev:code> <dev:remarks> <maml:para>Generates a CPR number without a hyphen.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/JensGJ/CPR/tree/main/src/docs/en-US/Get-CPR.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-CPR</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CPRInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |