_searchenv_s, _wsearchenv_s

  • [アーティクル]

環境のパスを使用してファイルを検索します。 これらのバージョンでは、「_wsearchenvCRT の_searchenvセキュリティ機能」で説明されているように、セキュリティが強化されています。

重要

この API は、Windows ランタイムで実行するアプリケーションでは使用できません。 詳細については、「ユニバーサル Windows プラットフォーム アプリでサポートされていない CRT 関数」を参照してください。

構文

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

パラメーター

filename
検索するファイルの名前。

varname
検索する環境。

pathname
完全パスを格納するバッファー。

numberOfElements
バッファーの pathname サイズ。

戻り値

正常終了した場合は 0 を返します。失敗した場合はエラー コードを返します。

filename に空の文字列が指定された場合は、返値は ENOENT になります。

エラー条件

filename varname pathname numberOfElements 戻り値 pathname の内容
any any NULL any EINVAL 該当なし
NULL any any any EINVAL 変更されない
any any any <= 0 EINVAL 変更されない

これらのエラー条件のいずれかが発生した場合は、「パラメーターの検証」で説明されているように、無効なパラメーター ハンドラーが呼び出されます。 実行の継続が許可された場合、これらの関数は errno を EINVAL に設定し、EINVAL を返します。

解説

_searchenv_s ルーチンは、指定したドメインでターゲット ファイルを検索します。 varname 変数は、PATH、LIB、および INCLUDE などのディレクトリ パスのリストを指定する環境変数またはユーザー定義変数です。 _searchenv_s では大文字と小文字が区別されるため、varname は環境変数と大文字小文字が一致する必要があります。 プロセスの環境で定義されている環境変数の名前と一致しない場合 varname 、関数は 0 を返し pathname 、変数は変更されません。

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

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

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

C++ では、これらの関数の使用はテンプレートのオーバーロードによって簡素化されます。オーバーロードでは、バッファー長を自動的に推論できる (サイズの引数を指定する必要がなくなる) だけでなく、古くてセキュリティが万全ではない関数を新しく安全な関数に自動的に置き換えることができます。 詳細については、「セキュリティで保護されたテンプレート オーバーロード」を参照してください。

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

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

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 );
}

Path for CL.EXE:
C:\Program Files\Microsoft Visual Studio 2010\VC\BIN\CL.EXE

関連項目

ディレクトリ コントロール
_searchenv, _wsearchenv
getenv, _wgetenv
_putenv, _wputenv