RpcNsProfileEltInqBeginA 関数 (rpcnsi.h)

  • [アーティクル]

RpcNsProfileEltInqBegin 関数は、プロファイル内の要素を表示するための照会コンテキストを作成します。

メモ この関数は、Windows Vista 以降のオペレーティング システムではサポートされていません。
 

構文

RPC_STATUS RpcNsProfileEltInqBeginA(
  unsigned long ProfileNameSyntax,
  RPC_CSTR      ProfileName,
  unsigned long InquiryType,
  RPC_IF_ID     *IfId,
  unsigned long VersOption,
  unsigned long MemberNameSyntax,
  RPC_CSTR      MemberName,
  RPC_NS_HANDLE *InquiryContext
);

パラメーター

ProfileNameSyntax

ProfileName の構文。

HKEY_LOCAL_MACHINE\Software\Microsoft\Rpc\NameService\DefaultSyntaxレジストリ 値エントリで 指定された構文を使用するには、 の値を指定RPC_C_NS_SYNTAX_DEFAULT。

ProfileName

表示するプロファイルの名前へのポインター。

InquiryType

プロファイルに対して実行する照会の種類。 次の表に、有効な照会の種類を示します。

お問い合わせの種類 意味
RPC_C_PROFILE_DEFAULT_ELT
 プロファイルで既定のプロファイル要素 (存在する場合) を検索します。 IfId、VersOption、および MemberName パラメーターは無視されます。
RPC_C_PROFILE_ALL_ELTS
 プロファイルからすべての要素を返します。 IfId、VersOption、および MemberName パラメーターは無視されます。
RPC_C_PROFILE_MATCH_BY_IF
 IfId および VersOption で指定されたインターフェイス ID を含む要素をプロファイルで検索します。 MemberName パラメーターは無視されます。
RPC_C_PROFILE_MATCH_BY_MBR
 MemberName を含む要素をプロファイルで検索します。 IfId パラメーターと VersOption パラメーターは無視されます。
RPC_C_PROFILE_MATCH_BY_BOTH
 IfId、VersOption、および MemberName パラメーターによって識別されるインターフェイス ID とメンバーを含む要素のプロファイルを検索します。

IfId

RpcNsProfileEltInqNext 関数によって返されるプロファイル要素のインターフェイス識別へのポインター。

IfId パラメーターは、InquiryType パラメーターにRPC_C_PROFILE_MATCH_BY_IFまたはRPC_C_PROFILE_MATCH_BY_BOTHの値を指定する場合にのみ使用されます。 それ以外の場合、 IfId は無視され、null 値を指定できます。

VersOption

RpcNsProfileEltInqNext 関数で IfId パラメーターを使用する方法を指定します。 このパラメーターは、 InquiryType に RPC_C_PROFILE_MATCH_BY_IF または RPC_C_PROFILE_MATCH_BY_BOTH の値を指定する場合にのみ使用されます。 それ以外の場合、このパラメーターは無視され、0 の値を指定できます。

次の表では、 VersOption の有効な値について説明します。

値 意味
RPC_C_VERS_ALL
 バージョン番号に関係なく、指定したインターフェイス UUID を提供するプロファイル要素を返します。 この値には、 IfId のメジャー バージョンとマイナー バージョンの両方に 0 を指定します。
RPC_C_VERS_COMPATIBLE
 指定したインターフェイス UUID のメジャー バージョンと、指定したインターフェイス UUID のマイナー バージョン以上のマイナー バージョンを提供するプロファイル要素を返します。
RPC_C_VERS_EXACT
 指定したインターフェイス UUID の指定されたバージョンを提供するプロファイル要素を返します。
RPC_C_VERS_MAJOR_ONLY
 指定したインターフェイス UUID の同じメジャー バージョンを提供するプロファイル要素を返します (マイナー バージョンは無視されます)。 この値には、 IfId のマイナー バージョンに 0 を指定します。
RPC_C_VERS_UPTO
 指定したインターフェイス UUID のバージョンが、指定したメジャー バージョンとマイナー バージョン以下のバージョンを提供するプロファイル要素を返します。 (たとえば、 IfId に V2.0 が含まれていて、プロファイルに V1.3、V2.0、V2.1 の要素が含まれている場合、 RpcNsProfileEltInqNext 関数は V1.3 および V2.0 の要素を返します)。

MemberNameSyntax

RpcNsProfileEltInqNext 関数の MemberName および戻り値パラメーター MemberName の構文。

HKEY_LOCAL_MACHINE\Software\Microsoft\Rpc\NameService\DefaultSyntaxレジストリ 値エントリで 指定された構文を使用するには、 の値を指定RPC_C_NS_SYNTAX_DEFAULT。

MemberName

RpcNsProfileEltInqNext 関数がプロファイル要素で検索するメンバー名へのポインター。 MemberName パラメーターは、InquiryType に RPC_C_PROFILE_MATCH_BY_MBR または RPC_C_PROFILE_MATCH_BY_BOTH の値を指定する場合にのみ使用されます。 それ以外の場合、 MemberName は無視され、null 値を指定できます。

InquiryContext

RpcNsProfileEltInqNext 関数および RpcNsProfileEltInqDone 関数で使用する名前サービス ハンドルへのポインターを返します。

戻り値

値 意味
RPC_S_OK
 呼び出しは成功しました。
RPC_S_INVALID_VERS_OPTION
 バージョン オプションが無効です。
RPC_S_INVALID_NAME_SYNTAX
 名前の構文が無効です。
RPC_S_UNSUPPORTED_NAME_SYNTAX
 名前の構文がサポートされていません。
RPC_S_INCOMPLETE_NAME
 名前が不完全です。
RPC_S_ENTRY_NOT_FOUND
 name-service エントリが見つかりませんでした。
RPC_S_NAME_SERVICE_UNAVAILABLE
 名前サービスを利用できません。
 
メモ 有効なエラー コードの一覧については、「 RPC 戻り値」を参照してください。
 

注釈

RpcNsProfileEltInqBegin 関数は、プロファイル内の要素を表示するための照会コンテキストを作成します。

InquiryType パラメーターを使用して、アプリケーションは RpcNsProfileEltInqNext の呼び出しから返される次のプロファイル要素のいずれかを指定します。

  • 既定の要素
  • すべての要素
  • 指定されたインターフェイス ID を持つ要素
  • 指定したメンバー名を持つ要素
  • 指定されたインターフェイス ID とメンバー名の両方を持つ要素
RpcNsProfileEltInqNext を呼び出す前に、アプリケーションはまず RpcNsProfileEltInqBegin を呼び出して照会コンテキストを作成する必要があります。

プロファイル要素の表示が完了すると、アプリケーションは RpcNsProfileEltInqDone 関数を呼び出して照会コンテキストを削除します。

メモ Windows 2000 Active Directory では、この機能がサポートされています。 以前のバージョンのWindows NTでは、Cell Directory Service (CDS) でのみこの関数の使用がサポートされています。
 

注意

rpcnsi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RpcNsProfileEltInqBegin を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー rpcnsi.h (Rpc.h を含む)
Library Rpcns4.lib
[DLL] Rpcns4.dll

こちらもご覧ください

RpcIfInqId

RpcNsProfileEltInqDone

RpcNsProfileEltInqNext