使用安全字符串操作函数

头文件

Strsafe

StringCchCopy（代替strcpy,wcscpy,_tcscpy,lstrcpy,StrCpy）

功能

• 复制一个字符串到缓冲区
• 下面是StrSafe.h中对这个函数的定义，可以看出来，这个函数要先检测字符串长度的有效性，然后才是根据参数进行字符串的复制操作。（这个函数分为A版本和W版本，下面是A版本的代码,W版本和这个类似）

参数分析

• 第一个参数是目标缓冲区，用于接收拷贝过来的字符串
• 第二个参数是目标缓冲区的大小： 这个值必须大于或等于pszSrc的长度+1，并且不应该超过STRSAFE_MAX_CCH
• 第三个参数是待拷贝的字符串

返回值

返回一个HRESULT，而不是指向缓冲区的指针。

• S_OK，字符串正常拷贝
• STRSAFE_E_INVALID_PARAMETER

1. cchDest 参数的值为 0
2. cchDest 参数的值大于 STRSAFE_MAX_CCH

• STRSAFE_E_INSUFFICIENT_BUFFER

1. 因缓冲区空间不足导致失败
2. 结果被截断，当仍然包含'\0'结尾
3. 如果截断操作可以被接受，则不一定被看作是失败

StringCchCopyA(
            _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest,
            _In_ size_t cchDest,
            _In_ STRSAFE_LPCSTR pszSrc)
{
    HRESULT hr;

    hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH);

    if (SUCCEEDED(hr))
    {
        hr = StringCopyWorkerA(pszDest,
                cchDest,
                NULL,
                pszSrc,
                STRSAFE_MAX_LENGTH);
    }
    else if (cchDest > 0)
    {
        *pszDest = '\0';
    }
    return hr;
}

StringCchCopyEx

• Ex一般是不带Ex的函数的扩展。在这里，后三个参数通常对进行完基本的字符串的操作之后，对于截断以及缓冲区的 处理。
• 使用Ex版本的函数，可以决定是否执行开销大的填充操作（尤其是在目标缓冲区很大的时候），以及用什么字符来进行填充。

参数说明

• 前三个参数参照第一个的说明
• 第四个参数表示pszDest结尾处的指针
• 第五个参数表示目标缓冲区的剩余空间长度。（包括结束符）
• 第六个参数可以使用：

1. STRSAFE_FILL_BEHIND_NULL，剩余字符串被设为\0
2. STRSAFE_IGNORE_NULLS
3. STRSAFE_FILL_ON_FAILURE
4. STRSAFE_NULL_ON_FAILURE
5. STRSAFE_NO_TRUNCATION

6. 如果使用STRSAFE_FILE_BYTE来代替STRSAFE_FILL_BEHIND_NULL，那么函数会用指定的字节来填充目标缓冲区中剩余的部分。

   
   
   

   图片发自App

具体使用可以查看：
https://msdn.microsoft.com/zh-cn/library/ms647529.aspx

StringCchCopyExA(
            _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest,
            _In_ size_t cchDest,
            _In_ STRSAFE_LPCSTR pszSrc,
            _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd,
            _Out_opt_ size_t* pcchRemaining,
            _In_ DWORD dwFlags)

StringCchCat

功能

• 字符串的连接
• 参数类似第一个函数，但是这个函数里的pszDest可以用作输入输出

StringCchCatA(
            _Inout_updates_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest,
            _In_ size_t cchDest,
            _In_ STRSAFE_LPCSTR pszSrc)
{
    HRESULT hr;
    size_t cchDestLength;

    hr = StringValidateDestAndLengthA(pszDest,
            cchDest,
            &cchDestLength,
            STRSAFE_MAX_CCH);

    if (SUCCEEDED(hr))
    {
        hr = StringCopyWorkerA(pszDest + cchDestLength,
                cchDest - cchDestLength,
                NULL,
                pszSrc,
                STRSAFE_MAX_LENGTH);
    }
    return hr;
}

StringCchCatEx

• 参数和第二个函数类似

 StringCchCatEx(
    _Inout_updates_(cchDest) _Always_(_Post_z_) LPTSTR  pszDest         OPTIONAL,
    _In_     size_t  cchDest,
    _In_     LPCTSTR pszSrc          OPTIONAL,
    _Outptr_opt_result_buffer_(*pcchRemaining)    LPTSTR* ppszDestEnd     OPTIONAL,
    _Out_opt_    size_t* pcchRemaining   OPTIONAL,
    _In_     DWORD   dwFlags
  );

StringCchPrintf

StringCchPrintfA(
            _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest,
            _In_ size_t cchDest,
            _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat,
            ...)
{
    HRESULT hr;
    hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH);
    if (SUCCEEDED(hr))
    {
        va_list argList;
        va_start(argList, pszFormat);
        hr = StringVPrintfWorkerA(pszDest,
                cchDest,
                NULL,
                pszFormat,
                argList);

        va_end(argList);
    }
    else if (cchDest > 0)
    {
        *pszDest = '\0';
    }
    return hr;
}