ホーム › NetworkManagement.WNet › PF_NPFormatNetworkName

PF_NPFormatNetworkName

コールバック

シグネチャ

DWORD PF_NPFormatNetworkName(
    LPWSTR lpRemoteName,
    LPWSTR lpFormattedName,
    DWORD* lpnLength,
    DWORD dwFlags,
    DWORD dwAveCharPerLine
);

パラメーター

フィールド

型

説明

lpRemoteName

LPWSTR

整形するネットワーク名へのポインターです。

lpFormattedName

LPWSTR

整形された名前を受け取る文字列へのポインターです。

lpnLength

DWORD*

lpFormattedName バッファーのサイズを文字単位で指定する DWORD へのポインターです。この関数の戻り値が WN_MORE_DATA の場合、lpnLength には必要なバッファーのサイズが文字単位で格納されます。

dwFlags

DWORD

要求される形式の種類を示すビットフィールドです。このパラメーターには、次のいずれかの値を指定できます。

値	意味
WNFMT_MULTILINE	プロバイダーは、名前の中で改行を入れる位置にバックスラッシュ n (\\n) を配置します。名前は完全な形で表現します。
WNFMT_ABBREVIATED	プロバイダーは、利用可能な領域にユーザーにとって最も有用な情報が収まるように、ネットワーク名を短縮します。

さらに、前述のフラグに対する修飾子として機能する次のフラグを、ビットごとの OR 演算で含めることができます。

値	意味
WNFMT_INENUM	ネットワーク名は列挙の文脈で表示され、列挙内ではネットワーク名の直前に「コンテナー」の名前が表示されます。これにより、ネットワークプロバイダーは整形後の名前から冗長な情報を取り除き、ユーザーにとって見やすい表示を提供できます。

dwAveCharPerLine

DWORD

ネットワーク名が表示される場所で、1 行に収まる平均文字数を指定します。具体的には、この値はコントロールの幅を、コントロールでの表示に使用されるフォントの TEXTMETRIC 構造体の tmAveCharWidth フィールドで割った値として定義されます。

公式ドキュメント

コントロールに表示するために、ネットワーク名をプロバイダー固有の形式に整形します。

戻り値

関数が成功した場合は、WN_SUCCESS を返します。

関数が失敗した場合は、次の値を返します。それ以外のエラーはすべて無視され、整形されていないネットワーク名が使用されます。

戻り値	説明
WN_MORE_DATA	入力バッファーが小さすぎます。

解説(Remarks)

この関数を使用すると、ネットワークベンダーは、ネットワーク名をユーザーに表示する前に切り詰めたり変更したりできます。たとえば、コモン Open ダイアログボックスの Drives コンボボックスには、接続されているすべてのリソースと、それに関連付けられたネットワーク名が表示されます。各項目が表示される前に NPFormatNetworkName が呼び出され、ネットワークプロバイダーは名前をコンボボックスに収まるように編集できます。さらに重要な点として、ネットワークプロバイダーは、ネットワーク名のうち最も重要な部分をユーザーに示すように名前を編集できます。

他のほとんどのネットワークプロバイダー関数とは異なり、NPFormatNetworkName は各ネットワークプロバイダーにルーティングされない点に注意してください。各ネットワークベンダーは、自身のネットワーク名の整形だけを考慮すれば十分です。 NPFormatNetworkName に渡されるのは、自身のネットワークプロバイダードライバーが生成した名前だけであると想定できます。

WNFMT_ フラグは通常、ユーザーインターフェイスのさまざまな場所で、次の表のとおりに渡されます。どのフラグがどこで渡されるかについて前提を置かないでください。この表は、各ネットワークベンダーが自身のネットワーク名を変更する最適な方法を判断する助けとしてのみ提供されています。

表示場所	WNFMT_ MULTILINE	WNFMT_ ABBREVIATED	WNFMT_ INENUM
ファイルマネージャーの Connection ダイアログボックス、Drive コンボボックスの選択部分。(コンボボックスの選択部分とは、リスト部分の上にある、現在の選択内容を表示する上側の矩形領域です。)		X
ファイルマネージャーの Connection ダイアログボックス、Drive コンボボックスのリスト部分。(コンボボックスのリスト部分とは、コンボボックスの選択部分の下に表示されるリストボックスです。)	X
ファイルマネージャーの Shared Directories リスト。		X	X
ファイルマネージャーの Disconnect Network Drive リスト。	X
ファイルマネージャーのツールバーのコンボボックスの選択部分。		X
ファイルマネージャーのツールバーのコンボボックスのリスト部分。	X
コモン Open および Save ダイアログボックス、Drive コンボボックスの選択部分。		X
コモン Open および Save ダイアログボックス、Drive コンボボックスのリスト部分。		X

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