_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 変数は、PATHLIB、または INCLUDE などのディレクトリ パスのリストを指定する任意の環境変数またはユーザー定義変数です。 _searchenv では大文字と小文字が区別されるため、varname は環境変数と大文字小文字が一致する必要があります。

このルーチンは最初に現在の作業ディレクトリでファイルを検索します。 ファイルが見つからない場合は、環境変数で指定されたディレクトリを検索します。 ターゲット ファイルがこれらのディレクトリのいずれかで見つかった場合は、新しく作成されたパスを pathname にコピーします。 ファイルが filename 見つからない場合は、 pathname null で終わる空の文字列が含まれます。

pathname バッファーは、_MAX_PATH 以上の文字数にして、作成されるパス名の最大の長さに対応できるようにする必要があります。 長さが足りないと、_searchenvpathname バッファーのオーバーランが発生し、予期しない動作が発生することがあります。

_wsearchenv_searchenv のワイド文字バージョンであり、_wsearchenv の引数はワイド文字列です。 それ以外では、_wsearchenv_searchenv の動作は同じです。

filename が空の文字列の場合は、これらの関数は ENOENT を返します。

pathnameポインターのNULL場合filenameは、「パラメーターの検証」で説明されているように、無効なパラメーター ハンドラーが呼び出されます。 実行の継続が許可された場合、これらの関数は -1 を返し、errnoEINVAL に設定します。

詳細errnoとエラー コードについては、定数を参照してくださいerrno

C++ では、これらの関数にテンプレートのオーバーロードがあります。このオーバーロードは、これらの関数に対応するセキュリティを強化された新しい関数を呼び出します。 詳細については、「セキュリティで保護されたテンプレート オーバーロード」を参照してください

既定では、この関数のグローバル状態の適用対象は、アプリケーションになります。 この動作を変更するには、「CRT のグローバル状態」を参照してください

汎用テキスト ルーチンのマップ

Tchar.h のルーチン _UNICODE_MBCS が定義されていない _MBCS が定義されている _UNICODE が定義されている
_tsearchenv _searchenv _searchenv _wsearchenv

必要条件

ルーチンによって返される値 必須ヘッダー
_searchenv <stdlib.h>
_wsearchenv <stdlib.h> または <wchar.h>

互換性の詳細については、「 Compatibility」を参照してください。

// 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