IWDFDevice2::CreateSymbolicLinkWithReferenceString メソッド (wudfddi.h)
[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、Windows 10 の新しいバージョンでは UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは、UMDF 2 を使用する必要があります。 詳細については、「UMDFの概要」を参照してください。
CreateSymbolicLinkWithReferenceString メソッドは、デバイスのシンボリック リンク名と、必要に応じて参照文字列を作成します
構文
HRESULT CreateSymbolicLinkWithReferenceString(
[in] PCWSTR pSymbolicLink,
[in, optional] PCWSTR pReferenceString
);
パラメーター
[in] pSymbolicLink
NULL-terminated 文字列へのポインター。デバイスのユーザーに表示される名前になります。 シンボリック リンク名は、グローバル DosDevices 名前空間に存在する必要があります。
[in, optional] pReferenceString
アプリケーションが pSymbolicLink パラメーターで指定したシンボリック名を使用する場合に Windows がデバイス名に追加する、NULL終了文字列へのポインター。 詳細については、次の「解説」セクションを参照してください。 このパラメーターは省略可能であり、NULL できます。
戻り値
CreateSymbolicLinkWithReferenceString 、操作が成功した場合にS_OKを返します。 それ以外の場合、メソッドは次のいずれかの値を返す可能性があります。
リターン コード | 形容 |
---|---|
|
呼び出し元が入力パラメーターに無効な値を指定しました。 |
|
メモリ割り当てに失敗しました。 |
このメソッドは、Winerror.h に含まれる他の値の 1 つを返す場合があります。
備考
CreateSymbolicLinkWithReferenceString 、IWDFDevice2 インターフェイスが表すデバイスのシンボリック リンク名と必要に応じて参照文字列を作成します。 ドライバーが CreateSymbolicLinkWithReferenceString 呼び出した後、アプリケーションはシンボリック リンク名を使用してデバイスにアクセスできます。
デバイスの名前が "\Device\MyDevice" であるとします。 pSymbolicLink パラメーターに "L"DeviceUserName" を指定することで、デバイスのシンボリック リンク名 "DeviceUserName" を作成できます。 pReferenceString パラメーターに "L"Instance3" を指定すると、\Device\MyDevice\Instance3 へのシンボリック リンクが作成されます。 アプリケーションがシンボリック リンク名を使用してデバイスを開いた場合、I/O マネージャーは \Device\MyDevice を開き、\Instance3 文字列をファイル名として含む WDM ファイル オブジェクトを作成します。 UMDF ベースのドライバーは、フレームワークによって作成されたファイル オブジェクトを受け取ります。このオブジェクトには、ファイル名として \Instance3 文字列も含まれます (IWDFFile::RetrieveFileNameを参照)。
通常、フレームワーク ベースのドライバーは、シンボリック リンクを提供する代わりに、アプリケーションがデバイスへのアクセスに使用できる デバイス インターフェイスを提供します。
デバイスが予期せず削除された場合 (突然削除)、フレームワークはデバイスへのシンボリック リンクを削除します。 ドライバーは、デバイスの新しいインスタンスのシンボリック リンク名を使用できます。
デバイスのシンボリック リンク名に参照文字列を追加する必要がない場合、ドライバーは CreateSymbolicLinkWithReferenceString ではなく、IWDFDevice::CreateSymbolicLink呼び出すことができます。
例
次の行は、グローバル DosDevices 名前空間にシンボリック リンク名プレフィックスを定義します。
#define SYMBOLIC_LINK_NAME_PREFIX L"\\DosDevices\\Global\\"
次のコード例では、シンボリック名文字列を作成し、IWDFDevice2 インターフェイスを取得してから、CreateSymbolicLinkWithReferenceString 呼び出します。
IWDFDevice2 *pDevice2 = NULL;
HRESULT hr;
//
// Create symbolic link name string.
//
hr = StringCchPrintf(portFullName,
portFullNameLength,
L"%ws%ws",
SYMBOLIC_LINK_NAME_PREFIX,
portName);
if (FAILED(hr))
{
goto Exit;
}
//
// Get a pointer to the IWDFDevice2 interface.
//
hr = pIWDFDevice->QueryInterface(__uuidof(IWDFDevice2),
(void**) &pDevice2);
if (SUCCEEDED(hr))
{
hr = pDevice2->CreateSymbolicLinkWithReferenceString(portFullName,
portCountString);
if (FAILED(hr))
{
goto Exit;
}
SAFE_RELEASE(pDevice2);
}
必要条件
要件 | 価値 |
---|---|
サポート終了 | UMDF 2.0 以降では使用できません。 |
ターゲット プラットフォーム の | デスクトップ |
UMDF の最小バージョン を する | 1.9 |
ヘッダー | wudfddi.h (Wudfddi.h を含む) |
DLL | WUDFx.dll |
関連項目
IWDFDevice2 の