@@ -3485,6 +3485,8 @@ on how to sequentially load table collections from a stream.
3485
3485
3486
3486
If the TSK_LOAD_SKIP_TABLES option is set, only the top-level
3487
3487
information of the table collection will be read, leaving all tables empty.
3488
+ If the TSK_LOAD_SKIP_REFERENCE_SEQUENCE option is set, the table collection is
3489
+ read without loading the reference sequence.
3488
3490
3489
3491
**Options**
3490
3492
@@ -3496,7 +3498,7 @@ TSK_NO_INIT
3496
3498
TSK_LOAD_SKIP_TABLES
3497
3499
Skip reading tables, and only load top-level information.
3498
3500
TSK_LOAD_SKIP_REFERENCE_SEQUENCE
3499
- TODO
3501
+ Do not load reference sequence.
3500
3502
3501
3503
**Examples**
3502
3504
@@ -3545,10 +3547,13 @@ different error conditions. Please see the
3545
3547
sequentially load tree sequences from a stream.
3546
3548
3547
3549
Please note that this streaming behaviour is not supported if the
3548
- TSK_LOAD_SKIP_TABLES option is set. With this option, only the top-level
3549
- information of the table collection will be read, leaving all tables empty. When
3550
- attempting to read from a stream with multiple table collection definitions and
3551
- the TSK_LOAD_SKIP_TABLES option set, only the top-level information of the first
3550
+ TSK_LOAD_SKIP_TABLES or TSK_LOAD_SKIP_REFERENCE_SEQUENCE option is set.
3551
+ If the TSK_LOAD_SKIP_TABLES option is set, only the top-level
3552
+ information of the table collection will be read, leaving all tables empty.
3553
+ If the TSK_LOAD_SKIP_REFERENCE_SEQUENCE option is set, the table collection is
3554
+ read without loading the reference sequence.
3555
+ When attempting to read from a stream with multiple table collection definitions
3556
+ and either of these two options set, the requested information from the first
3552
3557
table collection will be read on the first call to
3553
3558
:c:func:`tsk_table_collection_loadf`, with subsequent calls leading to errors.
3554
3559
@@ -3562,7 +3567,7 @@ TSK_NO_INIT
3562
3567
TSK_LOAD_SKIP_TABLES
3563
3568
Skip reading tables, and only load top-level information.
3564
3569
TSK_LOAD_SKIP_REFERENCE_SEQUENCE
3565
- TODO
3570
+ Do not load reference sequence.
3566
3571
3567
3572
@endrst
3568
3573
0 commit comments