_searchenv_s _wsearchenv_s

發行項
03/26/2013

搜尋使用環境路徑的檔案。這些是 _searchenv， _wsearchenv 版本與安全性增強的如安全性功能，則在 CRT 中中所述。

重要

這個 API 不能用於 Windows 執行階段執行的應用程式。如需詳細資訊，請參閱 CRT 函式不支援使用 /ZW。

errno_t _searchenv_s(
   const char *filename,
   const char *varname,
   char *pathname,
   size_t numberOfElements
);
errno_t _wsearchenv_s(
   const wchar_t *filename,
   const wchar_t *varname,
   wchar_t *pathname,
   size_t numberOfElements
);
template <size_t size>
errno_t _searchenv_s(
   const char *filename,
   const char *varname,
   char (&pathname)[size]
); // C++ only
template <size_t size>
errno_t _wsearchenv_s(
   const wchar_t *filename,
   const wchar_t *varname,
   wchar_t (&pathname)[size]
); // C++ only

參數

[in] filename
要搜尋的檔案名稱。
[in] varname
要搜尋的環境。
[out] pathname
儲存完整路徑的緩衝區。
[in] numberOfElements
pathname緩衝區的大小。

傳回值

零，如果成功;在失敗時的錯誤碼。

如果 filename 是空字串，則傳回值是 ENOENT。

錯誤情況

filename	varname	pathname	numberOfElements	傳回值	pathname的內容。
any	any	NULL	any	EINVAL	N/A
NULL	any	any	any	EINVAL	無法變更
any	any	any	<= 0	EINVAL	無法變更

如果這些錯誤任一事件，無效的參數叫用處理常式，如參數驗證中所述。如果執行允許繼續， EINVAL 和 EINVAL傳回的這些函式設定的 errno 。

備註

_searchenv_s 常式搜尋指定之網域的目標檔案。 varname 變數可以是指定目錄路徑清單，例如 PATH、 LIB和 INCLUDE的所有環境或使用者定義的變數。因為 _searchenv_s 會區分大小寫， varname 應該與環境變數的情況。如果 varname 不符合流程的環境中定義的環境變數的名稱，則函式會傳回零，而 pathname 變數並未變更。

常式會先搜尋目前工作目錄中的檔案。如果找不到檔案，它看起來下透過環境變數指定的目錄。如果目標檔案在這些目錄的其中一種，新建立的路徑複製到 pathname。如果 filename 檔案， pathname 包含空的 NULL 結尾字串。

pathname 緩衝區應該有符合完整長度的至少 _MAX_PATH 字元建構的路徑名稱。否則， _searchenv_s 可能滿溢 pathname 緩衝區造成未預期的行為。

_wsearchenv_s 是 _searchenv_s的寬字元版本;對 _wsearchenv_s 的引數是寬字元字串。 _wsearchenv_s 和 _searchenv_s 其餘行為相同。

在 C++ 中，使用這些函式由範本多載簡化;多載會推斷緩衝區長度 (自動排除指定大小引數)，也可以用它們較新，安全對應自動取代舊，不安全的函式。如需詳細資訊，請參閱安全範本多載。

泛用文字常式對應

Tchar.h 常式	未定義的 _UNICODE 和 _MBCS	已定義 _MBCS	已定義 _UNICODE
_tsearchenv_s	_searchenv_s	_searchenv_s	_wsearchenv_s

需求

程序	必要的標頭檔
_searchenv_s	<stdlib.h>
_wsearchenv_s	<stdlib.h> 或 <wchar.h>

如需更多關於相容性的資訊，請參閱入門介紹中的相容性 (Compatibility) 。

範例

// crt_searchenv_s.c
/* This program searches for a file in
 * a directory specified by an environment variable.
 */

#include <stdlib.h>
#include <stdio.h>

int main( void )
{
   char pathbuffer[_MAX_PATH];
   char searchfile[] = "CL.EXE";
   char envvar[] = "PATH";
   errno_t err;

   /* Search for file in PATH environment variable: */
   err = _searchenv_s( searchfile, envvar, pathbuffer, _MAX_PATH );
   if (err != 0)
   {
      printf("Error searching the path. Error code: %d\n", err);
   }
   if( *pathbuffer != '\0' )
      printf( "Path for %s:\n%s\n", searchfile, pathbuffer );
   else
      printf( "%s not found\n", searchfile );
}