Main Content

mdfAddAttachment

Attach file to MDF-file

Since R2022a

collapse all in page

    Syntax

    mdfAddAttachment(mdfFileName,attachmentFile)
    mdfAddAttachment(mdfFileName,attachmentFile,Name=Value)

    Description

    example

    mdfAddAttachment(mdfFileName,attachmentFile) attaches the attachmentFile to the specified mdfFileName.

    To attach multiple files, call this function separately for each file.

    The MDF-file itself can be on a remote server, but the attachments added by mdfAddAttachment must be local files.

    mdfAddAttachment(mdfFileName,attachmentFile,Name=Value) makes the attachment using additional options to control the means of attachment, to add a comment about the file, and to specify the media type.

    Note

    This function does not support MDF3 files.

    Examples

    collapse all

    Attach a CSV-file by emdedding it in an MDF-file.

    mdfAddAttachment("MDFFile.mf4","AttFile.csv",Embedded=true,Comment="Year-End",MIMEType="text/csv")

    Input Arguments

    collapse all

    MDF-file name, specified as a string or character vector, to add the attachment to. The file name can be a relative or absolute path.

    Depending on the location you are accessing, mdfFileName can take one of these forms.

    Location

    Form

    Current folder or MATLAB® path

    To access a file in the current folder or MATLAB path, specify the name of the file in filename, including the file extension.

    Example: "myMdfFile.mf4"

    Other folders

    To access a file in a folder other than the current folder, specify the full or relative path name in filename.

    Example: "C:\myFolder\myMdfFile.mf4"

    Example: "\dataDir\myMdfFile.mf4"

    Remote locations

    To access a file in a remote location, filename must contain the full path of the file specified as a uniform resource locator (URL) of the form:

    scheme://path_to_file/myMdfFile.mf4

    Based on the remote location, scheme can be one of the values in this table.

    Remote Locationscheme
    Amazon S3™s3
    Windows Azure® Blob Storagewasb, wasbs
    HDFS™hdfs

    For more information, see Work with Remote Data.

    Example: "s3://bucketname/path_to_file/myMdfFile.mf4"

    Example: "MDF_25Dec.mf4"

    Data Types: char | string

    File to be attached, specified as a string or character vector. The file name can be an absolute path or relative to the MDF-file location.

    Example: "Inv_MDF_25Dec.txt"

    Data Types: char | string

    Name-Value Arguments

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Example: Embedded=true

    Specify to embed attached file, as true (logical 1) or false (logical 0). This option determines whether the attachment is physically embedded in the MDF-file. If true, the attachment file is added as an embedded attachment. If false (default), the attachment file is added externally by referencing the attachment file path.

    If you move an MDF-file that has attachments that are not embedded, you might also have to move the attached files.

    Example: Embedded=true

    Data Types: logical

    Comment about attached file, specified as a string or character vector.

    Example: Comment="Stress Test Template"

    Data Types: char | string

    Media type and subtype of the attached file. The default is "application/ext", where "ext" is the file name extension. For more information on standard media types, see the Internet Assigned Numbers Authority (IANA) Media Types.

    Example: MIMEType="text/csv"

    Data Types: char | string

    Version History

    Introduced in R2022a

    expand all