BinaryFormat.Group

Returnerar ett binärformat som läser en grupp med objekt.

Syntax

BinaryFormat.Group(
    binaryFormat as function,
    group as list,
    optional extra as function,
    optional lastKey as any
) as function

Remarks

Parametrarna är som följer:

• Parametern binaryFormat anger binärformatet för nyckelvärdet.
• Parametern group ger information om gruppen med kända objekt.
• Den valfria parametern extra kan användas för att ange en funktion som returnerar ett värde i binärformat för oväntade nyckelvärden. Om parametern extra inte anges returneras ett fel om det finns oväntade nyckelvärden.

Parametern group anger en lista med objektdefinitioner. Varje objektdefinition är en lista som innehåller mellan 3 och 5 värden enligt följande:

• Nyckelvärde. Värdet på den nyckel som hör till objektet. Detta måste vara ett unikt värde i uppsättningen med objekt.
• Objektformat. Binärformatet för objektets värde. Detta gör att objekten kan ha olika format.
• Objektförekomst. BinaryOccurrence.Type-värdet som anger hur många gånger objektet förväntas förekomma i gruppen. Obligatoriska objekt som saknas genererar ett fel. Obligatoriska eller valfria dubblettobjekt hanteras som oväntade nyckelvärden.
• Standardobjektvärde (valfritt). Om standardobjektvärdet visas i objektdefinitionslistan och det inte är null, används det i stället för standardvärdet. Standardvärdet för upprepade eller valfria objekt är null, och standardvärdet för upprepade värden är en tom lista { }.
• Objektvärdetransformering (valfritt). Om funktionen för objektvärdetransformering finns med i objektdefinitionslistan och den inte är null, anropas funktionen för att transformera objektvärdet innan det returneras. Transform-funktionen anropas bara om objektet förekommer i dina indata (den anropas aldrig med standardvärdet).

Examples

Example #1

Följande förutsätter ett nyckelvärde som är en enskild byte, med 4 förväntade objekt i gruppen som samtliga har en byte data som följer efter nyckeln. Objekten visas i indata på följande sätt:<ul><li>Nyckel 1 är obligatorisk och visas med värdet 11.</li><li>Nyckel 2 upprepas och visas två gånger med värdet 22 och resulterar i värdet { 22, 22 }.</li><li>Nyckel 3 är valfri, visas inte och resulterar i ett null-värde.</li><li>Nyckel 4 upprepas men visas inte och resulterar i värdet { }.</li><li>Nyckel 5 är inte en del av gruppen, men visas en gång med värdet 55. Extra-funktionen anropas med nyckelvärdet 5 och returnerar formatet för det värdet (BinaryFormat.Byte). Värdet 55 läses och ignoreras.</li></ul>

let
    b = #binary({
        1, 11,
        2, 22,
        2, 22,
        5, 55,
        1, 11
    }),
    f = BinaryFormat.Group(
        BinaryFormat.Byte,
        {
            {1, BinaryFormat.Byte, BinaryOccurrence.Required},
            {2, BinaryFormat.Byte, BinaryOccurrence.Repeating},
            {3, BinaryFormat.Byte, BinaryOccurrence.Optional},
            {4, BinaryFormat.Byte, BinaryOccurrence.Repeating}
        },
        (extra) => BinaryFormat.Byte
    )
in
    f(b)

Result:

{11, {22, 22}, null, {}}

Example #2

Följande exempel illustrerar objektvärdetransformeringen och standardobjektvärdet. Det upprepade objektet med nyckel 1 summerar listan med värden som läses med List.Sum. Det valfria objektet med nyckel 2 har standardvärdet 123 i stället för null.

let
    b = #binary({
        1, 101,
        1, 102
    }),
    f = BinaryFormat.Group(
        BinaryFormat.Byte,
        {
            {1, BinaryFormat.Byte, BinaryOccurrence.Repeating,
              0, (list) => List.Sum(list)},
            {2, BinaryFormat.Byte, BinaryOccurrence.Optional, 123}
        }
    )
in
    f(b)

Result:

{203, 123}

Category

Binary Formats.Reading a group of items