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 で終わる文字列へのポインター。 シンボリック リンク名は、グローバル DosDevices 名前空間に存在する必要があります。

[in, optional] pReferenceString

アプリケーションが pSymbolicLink パラメーターで指定したシンボリック名を使用する場合に、Windows がデバイス名に追加する NULL で終わる文字列へのポインター。 詳細については、「解説」を参照してください。 このパラメーターは省略可能であり、 NULL にすることができます。

戻り値

操作が成功した場合、CreateSymbolicLinkWithReferenceString はS_OKを返します。 それ以外の場合、メソッドは次のいずれかの値を返す可能性があります。

リターン コード 説明
E_INVALIDARG
 呼び出し元が入力パラメーターに無効な値を指定しました。
E_OUTOFMEMORY
 メモリ割り当てに失敗しました。
 

このメソッドは、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
Header wudfddi.h (Wudfddi.h を含む)
[DLL] WUDFx.dll

こちらもご覧ください

IWDFDevice2

IWDFDevice::CreateSymbolicLink