TDMS_CreateInMemoryFile
- Updated2023-02-21
- 2 minute(s) read
TDMS_CreateInMemoryFile
int TDMS_CreateInMemoryFile (const char *name, const char *description, const char *title, const char *author, TDMSFileHandle *file);
Purpose
Creates a file handle for a new empty in-memory .tdms file. Pass the new file handle to other TDM Streaming Library functions to modify the file contents. Call TDMS_SaveInMemoryFileToDisk to save the file to disk.
Call the TDMS_CloseFile function to close the file handle when you finish using the file.
Parameters
| Input | ||
| Name | Type | Description |
| name | const char * | The value of the Name property of the file object. This property is stored in the file and can be accessed with the TDMS_SetFileProperty and TDMS_GetFileProperty functions. |
| description | const char * | The value of the Description property of the file object. This property is stored in the file and can be accessed with the TDMS_SetFileProperty and TDMS_GetFileProperty functions. |
| title | const char * | The value of the Title property of the file object. This property is stored in the file and can be accessed with the TDMS_SetFileProperty and TDMS_GetFileProperty functions. |
| author | const char * | The value of the Author property of the file object. This property is stored in the file and can be accessed with the TDMS_SetFileProperty and TDMS_GetFileProperty functions. |
| Output | ||
| Name | Type | Description |
| file | TDMSFileHandle | The handle for the TDM Streaming file. Pass this handle to TDM Streaming Library functions that require a file. Call TDMS_SaveInMemoryFileToDisk to save the file to disk. Call TDMS_CloseFile to close the file handle when you finish using the file. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. Unless otherwise stated, zero represents successful execution and a negative number represents the error code. Error codes are defined in cvi\include\cvitdms.h. |
Additional Information
Library: TDM Streaming Library
Include file: cvitdms.h
LabWindows/CVI compatibility: LabWindows/CVI 2019 and later
© 2016 National Instruments. All rights reserved.
Example
Refer to TDM Streaming\Advanced Read and Write\TDMS In Memory Write and Read\TDMS In Memory Write and Read.cws for an example of using the TDMS_CreateInMemoryFile function.