file returning from webApi with gibberish characters

receiving file from webApi with gibberish characters when file contains characters in different language.

I tried setting encoding on header but not helping. Please advise.

var dataBytes = File.ReadAllBytes(result.ReturnValue.ToString());

string fileName = Path.GetFileName(result.ReturnValue.ToString());

var dataStream = new MemoryStream(dataBytes);

HttpResponseMessage httpResponseMessage = new HttpResponseMessage(HttpStatusCode.OK);

httpResponseMessage.Content = new StreamContent(dataStream);

httpResponseMessage.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment");

httpResponseMessage.Content.Headers.ContentDisposition.FileName = fileName;

httpResponseMessage.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/octet-stream");

httpResponseMessage.Content.Headers.Add("Access-Control-Expose-Headers", "Content-Disposition");

//httpResponseMessage.Content.Headers.Add("Content-Transfer-Encoding", "utf-8");

//httpResponseMessage.Content.Headers.Add("charset", Encoding.ASCII.ToString());

//httpResponseMessage.Content.Headers.Add("charset", "utf-8");

//httpResponseMessage.Content.Headers.ContentEncoding.Add("gzip");

httpResponseMessage.Content.Headers.ContentEncoding.Add("utf-8");

return httpResponseMessage;

17 Replies

Know the answer? Post it — somebody with the same question will find it here.

Viswanatha Swamy6y ago
Good evening,
I have checked in the files into my GitHub Repository. Could you please download this on your local laptop and try executing it.

https://github.com/vishipayyallore/speaker_series/tree/master/C%23/DownloadFiles
Viswanatha Swamy6y ago
Good evening. I did not set anything else. I can do a screen share using Skype. Please advise.
6y ago
What is the encoding on your project?
and the encoding on your server\machine?
Viswanatha Swamy6y ago
Good evening. I was able to download without any issue. Please find the file contents.
6y ago
Thank you so much for your answer.
I'm so sorry but it is still not working for my content.
can you pls put hebrew letters in your file and see if the file returns correctly?
Viswanatha Swamy6y ago
Good evening. Below is the code I have tested on my box. Many thanks.

https://localhost:44399/api/downloads?fileName=Sample.txt
https://localhost:44399/api/downloads?fileName=Sample.xlsx
public HttpResponseMessage Get(string fileName)
        {
            var response = Request.CreateResponse(HttpStatusCode.OK);

            string filePath = HttpContext.Current.Server.MapPath("~/Downloads/") + fileName;

            if (!File.Exists(filePath))
            {
                response.StatusCode = HttpStatusCode.NotFound;
                response.ReasonPhrase = string.Format("File not found: {0} .", fileName);
                throw new HttpResponseException(response);
            }

            byte[] bytes = File.ReadAllBytes(filePath);
            response.Content = new ByteArrayContent(bytes);

            response.Content.Headers.ContentLength = bytes.LongLength;
            response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
            {
                FileName = fileName
            };

            response.Content.Headers.ContentType = new MediaTypeHeaderValue(MimeMapping.GetMimeMapping(fileName));

            return response;
        }
Image for Reference:
Viswanatha Swamy6y ago
Noted. Could you please give me a couple hours time? I will send you the link to the working code. Many thanks.
6y ago
Thank you for your help.
I'm returning files from different types: .htm, .xls and .txt.
.Net Framework v: v4.0.3
Viswanatha Swamy6y ago
What type of files you are sending it? Text, PDF? Please advise. Let me work out the full code and send you the link to the working code. Also, let me know the .Net Framework version.
6y ago
I'll try that.
Viswanatha Swamy6y ago
Ok I got it. The issue is the file content is Stream and media type. I think in your case it should be text/plain; charset=UTF-8

httpResponseMessage.Content = new StreamContent(dataStream);

Could you please change the content to Byte Array Content and Also fix the Content Type to the file type.
response.Content = new ByteArrayContent(bytes);
response.Content.Headers.ContentType = new MediaTypeHeaderValue(MimeMapping.GetMimeMapping(fileName));
6y ago
There was never an issue with the file name. The issue is with the content.
Viswanatha Swamy6y ago
Ok, that means now the file name issue is fixed. But the file content is still gibberish? Is my understanding correct? Please advise
6y ago
Thanks for your answer but file is still returning with gibberish characters in the content.
(The file name always returned correctly)
any other suggestion?
Viswanatha Swamy6y ago
I assume that is because of the code.
string fileName = Path.GetFileName(result.ReturnValue.ToString());
Could you please change it to the following
string fileName = sample.xls;
Once this is a success, we can think of dynamically generate the names. Many thanks.
6y ago
Hi,

Example for a file name: 50203538_04_73800.XLS

Thanks.
Viswanatha Swamy6y ago
Good evening. Is the fileName containing gibberish characters? Could you please give a sample of the file name?