次の方法で共有

IWDFRemoteInterfaceInitialize::RetrieveSymbolicLink メソッド (wudfddi.h)

  • [アーティクル]

[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは UMDF 2 を使用する必要があります。 詳細については、「UMDF を使用したはじめに」を参照してください。

RetrieveSymbolicLink メソッドは、オペレーティング システムがデバイス インターフェイスに割り当てたシンボリック リンク名を取得します。

構文

HRESULT RetrieveSymbolicLink(
  [out, optional] PWSTR pSymbolicLink,
  [in, out]       DWORD *pdwSymbolicLinkLengthInChars
);

パラメーター

[out, optional] pSymbolicLink

シンボリック リンク名を表す null で終わる Unicode 文字列を受け取るバッファーへのポインター。 このポインターを NULL に設定して、必要なバッファー サイズを取得します。

[in, out] pdwSymbolicLinkLengthInChars

呼び出し元によって割り当てられた場所へのポインター。 入力時に、この場所には 、pSymbolicLink が指すバッファーの呼び出し元から指定された長さが含まれている必要があります。 出力時に、ロケーションはシンボリック・リンク名の長さ ( NULL 終了文字を含む) を文字単位で受け取ります。

戻り値

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

リターン コード 説明
E_NOT_SUFFICIENT_BUFFER
 pSymbolicLink が指すバッファーが小さすぎます。 この場合、フレームワークは pdwSymbolicLinkLengthInChars が指す場所に必要なバッファー サイズを格納します。
 

このメソッドは、Winerror.h に含まれる他の値のいずれかを返す場合があります。

注釈

シンボリック リンク名には、追加された円記号 () 文字の後にインスタンス固有の参照文字列を含めることができます。

通常、ドライバーは次のように RetrieveSymbolicLink を 2 回呼び出す必要があります。

  1. pSymbolicLink パラメーターを NULL に設定し、RetrieveSymbolicLink を呼び出します。 pdwSymbolicLinkLengthInChars が指す場所は、シンボリック リンク名に含まれる文字数を受け取ります。
  2. シンボリック リンク名を受け取るのに十分な大きさのバッファーを割り当てます。
  3. RetrieveSymbolicLink をもう一度呼び出し、pSymbolicLink パラメーターを割り当てたバッファーのアドレスに設定します。
RetrieveSymbolicLink メソッドの詳細については、「UMDF ベースのドライバーでのデバイス インターフェイスの使用」を参照してください。

例

次のコード例は、ドライバーの IPnpCallbackRemoteInterfaceNotification::OnRemoteInterfaceArrival コールバック関数がデバイス インターフェイスのシンボリック リンク名の長さを決定し、名前にバッファーを割り当ててから、名前を取得する方法を示しています。

void 
STDMETHODCALLTYPE
CMyDevice::OnRemoteInterfaceArrival(
    __in IWDFRemoteInterfaceInitialize  *FxRemoteInterfaceInit
    )
{
    HRESULT hr;
    INT BufferSize;
    hr= FxRemoteInterfaceInit->RetrieveSymbolicLink(NULL,
                                                    &BufferSize);
    if (FAILED(hr)) goto Error;
    hr = FxDriver->CreateWdfMemory(BufferSize, 
                                   NULL, 
                                   FxRemoteInterface, 
                                   &FxSymLinkBuffer);
    if (FAILED(hr)) goto Error;
    hr= FxRemoteInterfaceInit->RetrieveSymbolicLink(FxSymLinkBuffer->GetDataBuffer(NULL),
                                                    &BufferSize);
    if (FAILED(hr)) goto Error;
...
Error:
...
}

要件

要件 値
サポート終了 UMDF 2.0 以降では使用できません。
対象プラットフォーム デスクトップ
最小 UMDF バージョン 1.9
Header wudfddi.h (Wudfddi.h を含む)
[DLL] WUDFx.dll

こちらもご覧ください

IWDFRemoteInterfaceInitialize

IWDFRemoteInterfaceInitialize::GetInterfaceGuid