NPFormatNetworkName 関数 (npapi.h)

  • [アーティクル]

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

構文

DWORD NPFormatNetworkName(
  [in]      LPWSTR  lpRemoteName,
  [out]     LPWSTR  lpFormattedName,
  [in, out] LPDWORD lpnLength,
  [in]      DWORD   dwFlags,
  [in]      DWORD   dwAveCharPerLine
);

パラメーター

[in] lpRemoteName

書式設定するネットワーク名へのポインター。

[out] lpFormattedName

書式設定された名前を受け取る文字列へのポインター。

[in, out] lpnLength

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

[in] dwFlags

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

値 意味
WNFMT_MULTILINE
 プロバイダーは、名前に改行が表示されるバックスラッシュ n (\\n) を配置する必要があります。 完全な名前を表す必要があります。
WNFMT_ABBREVIATED
 プロバイダーは、ユーザーに最も役立つ情報が使用可能な領域に収まるように、ネットワーク名を短くする必要があります。
 

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

値 意味
WNFMT_INENUM
 ネットワーク名は、列挙型のネットワーク名の直前に "コンテナー" の名前が表示される列挙型のコンテキストで表示されます。 これにより、ネットワーク プロバイダーは、書式設定された名前から冗長な情報を削除できるため、ユーザーの表示が煩雑になります。

[in] dwAveCharPerLine

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

戻り値

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

関数が失敗した場合は、次の値が返されます。 その他のエラーはすべて無視され、書式設定されていないネットワーク名が使用されます。

リターン コード 説明
WN_MORE_DATA
 入力バッファーが小さすぎます。

注釈

この機能を使用すると、ネットワーク ベンダーは、ユーザーに表示される前にネットワーク名をトリミングまたは変更できます。 たとえば、共通の [開く ] ダイアログ ボックスの [ ドライブ ] コンボ ボックスには、接続されているすべてのリソースとそれに関連付けられているネットワーク名が表示されます。 各項目が表示される前に NPFormatNetworkName が呼び出され、ネットワーク プロバイダーには、コンボ ボックスに収まるように名前を編集するオプションがあります。 さらに重要なのは、ネットワーク プロバイダーが名前を編集して、ネットワーク名の最も重要な部分をユーザーに表示できることです。

NPFormatNetworkName は、他のほとんどのネットワーク プロバイダー関数と同様に、各ネットワーク プロバイダーにルーティングされないことに注意してください。 各ネットワーク ベンダーは、独自のネットワーク名の書式設定についてのみ心配する必要があります。 ネットワーク プロバイダー ドライバーによって生成された名前のみが NPFormatNetworkName に渡されると想定できます。

通常、WNFMT_ フラグは、次の表に示すように、ユーザー インターフェイスのさまざまな場所で渡されます。 どのフラグがどこで渡されるのかについて、想定を立ててはいけません。この表は、各ネットワーク ベンダーがネットワーク名を変更するための最適な方法を決定するのに役立つためだけに用意されています。

表示場所 複数行のWNFMT_ 省略WNFMT_ INENUM をWNFMT_する
[ファイル マネージャー の接続 ] ダイアログ ボックス、[ ドライブ ] コンボ ボックス、選択。 (コンボ ボックスの選択セクションは、現在の選択範囲を表示するリスト セクションの上にある上の四角形です)。   X  
[ファイル マネージャー の接続 ] ダイアログ ボックス、[ ドライブ ] コンボ ボックス、一覧。 (コンボ ボックスのリスト セクションは、コンボ ボックスの選択部分の下に表示されるリスト ボックスです)。 X    
[ファイル マネージャー]、[ 共有ディレクトリ] の一覧。   X X
ファイル マネージャー の [ネットワーク ドライブの切断 ] の一覧。 X    
ファイル マネージャー、ツール バー、コンボ ボックス、選択。   X  
ファイル マネージャー、ツール バー、コンボ ボックス、リスト。 X    
共通 の [開く ] ダイアログ ボックスと [保存] ダイアログ ボックス、[ ドライブ ] コンボ ボックス、選択。   X  
共通 の [開く ] ダイアログ ボックスと [保存] ダイアログ ボックス、[ ドライブ ] コンボ ボックス、リスト。   X  

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー npapi.h