Xceed Binary Encoding Library Documentation
Xceed Binary Encoding control reference / Encoding Format objects / XceedBinHexEncodingFormat object / HeaderFilename property
In This Topic
    HeaderFilename property
    In This Topic

    Description

    The HeaderFilename property allows you to get or set the filename in the header of data being encoded or decoded.

    When encoding with the Encode or ReadFile method, a value for this property must be specified because the library has no way of determining what filename should be encoded in the header.

    When encoding with the ReadFile or ProcessFile method, this property can be left empty. In this case the library will use the method's sSourceFilename parameter to determine the filename to put into the header of the data being encoded.

    When decoding, as soon as the called method returns decoded data, this property's value will be changed to the filename in the header of the encoded data.

    Data type

    BSTR

    Default value

    Empty string

    Remarks

    The BinHex format does not support more than 63 characters in a filename.

    Applicable methods

    Encode, Decode, ProcessFile, ReadFile, WriteFile