_searchenv, _wsearchenv

使用環境路徑來搜尋檔案。 這些函式有更安全的版本可供使用;請參閱 _searchenv_s_wsearchenv_s

重要

這個 API 不能用於在 Windows 執行階段中執行的應用程式。 如需詳細資訊,請參閱 CRT functions not supported in Universal Windows Platform apps (通用 Windows 平台應用程式中不支援的 CRT 函式)。

語法

void _searchenv(
   const char *filename,
   const char *varname,
   char *pathname
);
void _wsearchenv(
   const wchar_t *filename,
   const wchar_t *varname,
   wchar_t *pathname
);
template <size_t size>
void _searchenv(
   const char *filename,
   const char *varname,
   char (&pathname)[size]
); // C++ only
template <size_t size>
void _wsearchenv(
   const wchar_t *filename,
   const wchar_t *varname,
   wchar_t (&pathname)[size]
); // C++ only

參數

filename
要搜尋的檔案名稱。

varname
要搜尋的環境。

pathname
要儲存此完整路徑的緩衝區。

備註

_searchenv 常式會搜尋指定網域中的目標檔案。 varname 變數可以是指定目錄路徑清單之任何環境或使用者定義的變數,例如 PATHLIBINCLUDE。 因為 _searchenv 會區分大小寫,所以 varname 應該要與環境變數的大小寫相符。

此常式會先搜尋目前工作目錄中的檔案。 如果找不到檔案,它會查看環境變數所指定的目錄。 如果目標檔案在這些目錄其中之一,則會將新建立的路徑複製到 pathname。 如果找不到檔案 filenamepathname 則包含空的 Null 終止字串。

pathname 緩衝區應該要有至少 _MAX_PATH 字元的長度,藉此容納全部長度的建構路徑名稱。 否則,_searchenv 可能讓 pathname 緩衝區滿溢,並造成未預期的行為。

_wsearchenv_searchenv 的寬字元版本;而 _wsearchenv 的引數是寬字元字串。 否則,_wsearchenv_searchenv 的行為即會相同。

如果 filename 是空字串,則這些函式會傳回 ENOENT

如果 filenamepathnameNULL 指標,則會叫用不正確參數處理常式,如參數驗證 中所述 。 如果允許繼續執行,這些函式會傳回 -1,並將 errno 設為 EINVAL

如需 和 錯誤碼的詳細資訊 errno ,請參閱 errno 常數

在 C++ 中,這些函式具有多載樣板,可以叫用這些函式的更新、更安全之對應版本。 如需詳細資訊,請參閱 保護範本多載

根據預設,此函式的全域狀態會限定于應用程式。 若要變更此行為,請參閱 CRT 中的全域狀態。

泛型文字常式對應

Tchar.h 常式 _UNICODE_MBCS 未定義 _MBCS 定義 _UNICODE 定義
_tsearchenv _searchenv _searchenv _wsearchenv

需求

常式 必要的標頭
_searchenv <stdlib.h>
_wsearchenv <stdlib.h > 或 < wchar.h>

如需相容性詳細資訊,請參閱相容性

範例

// crt_searchenv.c
// compile with: /W3
// This program searches for a file in
// a directory that's 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";

   // Search for file in PATH environment variable:
   _searchenv( searchfile, envvar, pathbuffer ); // C4996
   // Note: _searchenv is deprecated; consider using _searchenv_s
   if( *pathbuffer != '\0' )
      printf( "Path for %s:\n%s\n", searchfile, pathbuffer );
   else
      printf( "%s not found\n", searchfile );
}
Path for CL.EXE:
C:\Program Files\Microsoft Visual Studio 8\VC\BIN\CL.EXE

另請參閱

目錄控制項
getenv, _wgetenv
_putenv, _wputenv
_searchenv_s, _wsearchenv_s