ホーム › NetworkManagement.WNet › PF_NPGetPropertyText

PF_NPGetPropertyText

コールバック

シグネチャ

DWORD PF_NPGetPropertyText(
    DWORD iButton,
    DWORD nPropSel,
    LPWSTR lpName,
    LPWSTR lpButtonName,
    DWORD nButtonNameLen,
    DWORD nType
);

パラメーター

フィールド

型

説明

iButton

DWORD

ボタンのインデックスを示します。File Manager は最大 6 個のボタンをサポートします。このパラメーターは、選択されているファイルが 1 つだけの場合は各ボタンに対して 1〜6、複数のファイルが選択されている場合は 11〜16 の番号になります。

nPropSel

DWORD

プロパティダイアログボックスがどの項目を対象とするかを指定します。次のいずれかの値を指定できます。

値	意味
WNPS_FILE	単一のファイルです。
WNPS_DIR	単一のディレクトリです。
WNPS_MULT	複数のファイル、ディレクトリ、またはその両方の選択です。

lpName

LPWSTR

ダイアログボックスで表示または編集する項目の名前を格納した、null で終わる文字列へのポインターです。サポートされる項目はファイルとディレクトリのみであるため、項目名はファイル名になります。これらの名前は曖昧さがなく、ワイルドカード文字を含まず、完全修飾されている必要があります (例: C:\LOCAL\EXAMPLE.DOC)。複数のファイル名はスペースで区切ります。スペースを含むファイル名は引用符で囲むことができます (例: "C:\My File")。この場合、単一の名前として扱われます。キャレット文字 '^' も 1 文字単位の引用機構として使用できます (例: C:\My^"File と "C:\My^"File" は、どちらもファイル C:\My"File を指します)。

lpButtonName

LPWSTR

ネットワークプロバイダーがプロパティボタンの名前をコピーするバッファーへのポインターです。成功した場合、lpButtonName が指すバッファーにはプロパティボタンの名前が格納されます。関数の終了時にこのバッファーが空文字列である場合、その名前に対応するボタンと、それ以降のすべてのボタンがダイアログボックスから削除されます。ネットワークプロバイダーはボタンを「スキップ」することはできません。

nButtonNameLen

DWORD

lpButtonName バッファーのサイズを、終端の null 文字を含む文字数で指定します。

nType

DWORD

項目の種類を指定します。WNTYPE_FILE でなければなりません。

公式ドキュメント

ネットワークリソースのプロパティダイアログボックスに追加するボタンの名前を取得します。

戻り値

関数が成功した場合は WN_SUCCESS を返し、lpButtonName を使用できます。それが空文字列を指している場合、iButton ほど大きいインデックスに対応するボタンは存在しません。戻り値が WN_SUCCESS 以外の場合、プロバイダーは SetLastError も呼び出して拡張エラー情報を設定する必要があります。拡張エラーコードには次のものがあります。

戻り値	説明
WN_OUT_OF_MEMORY	リソースから文字列を読み込めませんでした。
WN_MORE_DATA	指定されたバッファーが小さすぎて、ボタンのテキストを格納できません。
WN_BAD_VALUE	lpName パラメーターの形式が想定外です。
WN_NOT_SUPPORTED	指定されたオブジェクトの種類 nType では、プロパティダイアログボックスはサポートされていません。

解説(Remarks)

File Manager は、プロパティダイアログボックスが表示されるたびに、ダイアログボックスを表示する前にこの関数を呼び出します。ネットワークプロバイダーがこの関数によって追加したボタンをユーザーがクリックすると、適切なパラメーターを指定して NPPropertyDialog 関数が呼び出されます。

NPGetPropertyText を呼び出すのは File Manager のみであり、ファイルとディレクトリに対してこの関数を使用します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)