BinaryFormat.List

 

This topic applies to the Power Query Formula Language which can be used with Power Query and Power BI Desktop to build queries that mashup data. See the list of function categories.

Returns a binary format that reads a sequence of items and returns a list.

BinaryFormat.List(binaryFormat as function, optional countOrCondition as any) as function  

ArgumentDescription
binaryFormatThe binary format of each item.
optional countOrConditionSee Remarks

There are three ways to determine the number of items read:

  • If the countOrCondition is not specified, then the binary format will read until there are no more items.

  • If the countOrCondition is a number, then the binary format will read that many items.

  • If the countOrCondition is a function, then that function will be invoked for each item read. The function returns true to continue, and false to stop reading items. The final item is included in the list.

// Read bytes until the end of the data.letbinaryData = #binary({1, 2, 3}),listFormat = BinaryFormat.List(BinaryFormat.Byte)inlistFormat(binaryData) equals {1, 2, 3}

// Read two bytes.  
letbinaryData = #binary({1, 2, 3}),  
listFormat = BinaryFormat.List(BinaryFormat.Byte, 2)  
in  
listFormat(binaryData)   
equals {1, 2}  

// Read bytes until the byte value is greater than or equal to two.  
let  
binaryData = #binary({1, 2, 3}),  
listFormat = BinaryFormat.List(BinaryFormat.Byte, (x) => x < 2)  
in  
listFormat(binaryData)   
equals {1, 2}  

Show: