次の方法で共有

_searchenv_s、_wsearchenv_s

  • [アーティクル]

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

重要 : 重要

この API は、Windows のランタイムで実行するアプリケーションで使用することはできません。詳細については、でサポート /ZW 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 の内容

任意

任意

NULL

任意

EINVAL

適用なし

NULL

任意

任意

任意

EINVAL

変更されない

任意

任意

任意

0 以下

EINVAL

変更されない

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

解説

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

ルーチンが現在の作業ディレクトリのファイルを検索します。ファイルを検索、環境変数で指定されたディレクトリを介して次に表示されます。ターゲット ファイルがそれらのディレクトリの 1 にある場合は、新しく作成されたパスは 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>

互換性の詳細については、「C ランタイム ライブラリ」の「互換性」を参照してください。

使用例

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

同等の .NET Framework 関数

該当なし標準 C 関数を呼び出すには、PInvoke を使用します。詳細については、「プラットフォーム呼び出しの例」を参照してください。

参照

関連項目

ディレクトリ制御

_searchenv、_wsearchenv

getenv、_wgetenv

_putenv、_wputenv