From 10628e437af1d4504306ef3d68d9b7f5c19121b1 Mon Sep 17 00:00:00 2001 From: Hilko Bengen Date: Tue, 22 Aug 2023 15:55:17 +0200 Subject: [PATCH] doc: Add examples for utf16, utf16_encode --- docs/references/vql.yaml | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/references/vql.yaml b/docs/references/vql.yaml index 3a88134a9e5..427cfa888ec 100644 --- a/docs/references/vql.yaml +++ b/docs/references/vql.yaml @@ -6304,7 +6304,13 @@ type: Plugin category: windows - name: utf16 - description: Parse input from utf16. + description: | + Parse input from utf16. + + ### Example + ```vql + utf16(string='A\x00B\x00C\x00D\x00') -> "ABCD" + ``` type: Function args: - name: string @@ -6313,7 +6319,13 @@ required: true category: basic - name: utf16_encode - description: Encode a string to utf16 bytes. + description: | + Encode a string to utf16 bytes. + + ### Example + ```vql + utf16_encode(string="ABCD") -> "A\u0000B\u0000C\u0000D\u0000" + ``` type: Function args: - name: string