_searchenv_wsearchenv

使用环境路径搜索文件。 提供这些函数的更安全版本;请参阅 _searchenv_s_wsearchenv_s

重要

此 API 不能用于在 Windows 运行时中执行的应用程序。 有关详细信息,请参阅通用 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 中。 如果找不到 filename 文件,pathname 将包含一个以 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