MprConfigGetFriendlyName 関数 (mprapi.h)

MprConfigGetFriendlyName 関数は、指定された GUID 名に対応するインターフェイスのフレンドリ名を返します。

構文

DWORD MprConfigGetFriendlyName(
  [in]  HANDLE hMprConfig,
  [in]  PWSTR  pszGuidName,
  [out] PWCHAR pszBuffer,
  [in]  DWORD  dwBufferSize
);

[in] hMprConfig

ルーター構成を処理します。 MprConfigServerConnect を呼び出して、このハンドルを取得します。

[in] pszGuidName

インターフェイスの GUID 名を指定する null で終わる Unicode 文字列へのポインター。

[out] pszBuffer

インターフェイスのフレンドリ名を受け取るバッファーへのポインター。

[in] dwBufferSize

pszBuffer が指すバッファーのサイズをバイト単位で指定します。

関数が成功した場合、戻り値はNO_ERROR。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

値	意味
ERROR_BUFFER_OVERFLOW	pszBuffer が指すバッファーは、返された GUID 名を保持するのに十分な大きさではありません。
ERROR_INVALID_PARAMETER	次のパラメーター hMprConfig、 pszGuidName、または pszBuffer のいずれかが NULL です。
ERROR_NOT_FOUND	指定したフレンドリ名に対応する GUID 名が見つかりませんでした。

詳しくは、「バッファーオーバーランの回避」をご覧ください。