fs_codec_r.h File Reference

Header file for Base module of Foxit PDF SDK. More...

Go to the source code of this file.

Classes

struct  FSCRT_DIGEST
 Handle type to a DIGEST. More...
 

Macros

Macro Definitions for Digest Algorithm Types
#define FSCRT_DIGEST_MD5   1
 For MD5 algorithm that generates 128 bits digest.
 
#define FSCRT_DIGEST_SHA1   2
 For SHA1 algorithm that generates 128 bits digest.
 
#define FSCRT_DIGEST_SHA256   3
 For SHA256 algorithm that generates 256 bits digest.
 
#define FSCRT_DIGEST_SHA384   4
 For SHA384 algorithm that generates 384 bits digest.
 
#define FSCRT_DIGEST_SHA512   5
 For SHA512 algorithm that generates 512 bits digest.
 

Functions

FS_RESULT FSCRT_UTF8_CountChars (const FSCRT_BSTR *utf8Str, FS_DWORD *count, FS_DWORD *pos)
 Get count of characters stored in a UTF-8 string. More...
 
FS_RESULT FSCRT_UTF8_ToUTF16LE (const FSCRT_BSTR *utf8Str, FS_WORD *buffer, FS_DWORD *length)
 Convert a UTF-8 string to a UTF-16LE string. More...
 
FS_RESULT FSCRT_UTF8_ToUTF16BE (const FSCRT_BSTR *utf8Str, FS_WORD *buffer, FS_DWORD *length)
 Convert a UTF-8 string to a UTF-16BE string. More...
 
FS_RESULT FSCRT_UTF8_ToUTF32LE (const FSCRT_BSTR *utf8Str, FS_DWORD *buffer, FS_DWORD *length)
 Convert a UTF-8 string to a UTF-32LE string. More...
 
FS_RESULT FSCRT_UTF8_ToUTF32BE (const FSCRT_BSTR *utf8Str, FS_DWORD *buffer, FS_DWORD *length)
 Convert a UTF-8 string to a UTF-32BE string. More...
 
FS_RESULT FSCRT_UTF8_FromUTF16LE (FSCRT_BSTR *utf8Str, const FS_WORD *buffer, FS_DWORD length)
 Encode a UTF-16LE string into a UTF-8 string. More...
 
FS_RESULT FSCRT_UTF8_FromUTF16BE (FSCRT_BSTR *utf8Str, const FS_WORD *buffer, FS_DWORD length)
 Convert a UTF-16BE string into a UTF-8 string. More...
 
FS_RESULT FSCRT_UTF8_FromUTF32LE (FSCRT_BSTR *utf8Str, const FS_DWORD *buffer, FS_DWORD length)
 Convert a UTF-32LE string into a UTF-8 string. More...
 
FS_RESULT FSCRT_UTF8_FromUTF32BE (FSCRT_BSTR *utf8Str, const FS_DWORD *buffer, FS_DWORD length)
 Convert a UTF-32BE string into a UTF-8 string. More...
 
FS_RESULT FSCRT_Base64_DecodeToBuffer (const FSCRT_BSTR *base64Str, FS_LPVOID buffer, FS_DWORD *length, FS_DWORD *pos)
 Convert a BASE-64 string into a buffer. More...
 
FS_RESULT FSCRT_Base64_EncodeFromBuffer (FSCRT_BSTR *base64Str, FS_LPCVOID buffer, FS_DWORD length)
 Encode a buffer into a BASE-64 string. More...
 
FS_RESULT FSCRT_Digest_Start (FS_INT32 digestType, FSCRT_DIGEST *digest)
 Setup a DIGEST context. More...
 
FS_RESULT FSCRT_Digest_Update (FSCRT_DIGEST digest, FS_LPVOID buf, FS_DWORD size)
 Update the DIGEST with some new data. Function FSCRT_Digest_Start must be called before. More...
 
FS_RESULT FSCRT_Digest_Finish (FSCRT_DIGEST digest, FSCRT_BSTR *hash)
 Finish the process and output the digest. More...
 
FS_RESULT FSCRT_Flate_Compress (const FSCRT_BSTR *src, FSCRT_BSTR *dst)
 Compress data by using the flate algorithm. More...
 
FS_RESULT FSCRT_Flate_Decompress (const FSCRT_BSTR *src, FSCRT_BSTR *dst)
 Decompress data by using the flate algorithm. More...
 

Detailed Description

Header file for Base module of Foxit PDF SDK.

Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and contains proprietary information and trade secrets of Foxit Software Inc.. It is not allowed to distribute any parts of Foxit PDF SDK to any third parties or general public, unless there is a license agreement between Foxit Software Inc. and customers.

This header file is a supplement for fs_base_r.h. It defines functions about coding conversion and digest algorithms.
It contains:

  • 1. UTF-8 encoding and decoding.
  • 2. Base-4 encoding and decoding.
  • 3. Digest algorithms.
  • 4. Flate encoding and decoding.
Note
If you want to purchase Foxit PDF SDK license and use ANY of the following functions, please request for enabling Standard module explicitly.

Foxit Corporation