TLSLicenseEnumBegin 関数

検索条件に基づいてリモート デスクトップ ライセンス サーバーによって発行されるライセンスの列挙を開始します。

Note

この関数には、ヘッダー ファイルまたはインポート ライブラリが関連付けされません。 この関数を呼び出すには、ユーザー定義ヘッダー ファイルを作成し、 LoadLibrary 関数と GetProcAddress 関数を使用して、Mstlsapi.dllに動的にリンクする必要があります。

構文

DWORD WINAPI TLSLicenseEnumBegin(
  _In_  TLS_HANDLE hHandle,
  _In_  DWORD      dwSearchParm,
  _In_  BOOL       bMatchAll,
  _In_  LSLicense  *lpSearchParm,
  _Out_ PDWORD     pdwErrCode
);

パラメーター

hHandle [in]

リモート デスクトップ ライセンス サーバーへの処理。 TLSConnectToLsServer 関数によって開かれるハンドルを指定します。

dwSearchParm [in]

検索条件を指定します。 パラメーターには、次の一覧で説明する値の 1 つまたは組み合わせを指定できます。 パラメーターは、キー パックの種類と検索するキー パックを指定します。

LSLICENSE_SEARCH_LICENSEID (0x00000001)

ライセンス ID で検索します。

LSLICENSE_SEARCH_KEYPACKID (0x00000002)

キー パック ID で検索します。

LSLICENSE_SEARCH_MACHINENAME (0x00000008)

コンピューター名で検索します。

LSLICENSE_SEARCH_USERNAME (0x00000010)

ユーザー名で検索します。

LSLICENSE_SEARCH_ISSUEDATE (0x00000080)

発行日で検索します。

LSLICENSE_SEARCH_EXPIREDATE (0x00000100)

有効期限で検索します。

NUMLICENSES のLSLICENSE_SEARCH_ (0x00000200)

ライセンスの数で検索します。

LSLICENSE_SEARCH_ ENTRY_STATUS (0x20000000)

エントリの状態で検索します。

LSLICENSE_EXSEARCH_LICENSESTATUS (0x00100000)

ライセンスの状態で検索します。

LSKEYPACK_SEARCH_ALL (0xFFFFFFFF)

すべてのライセンスを検索します。

bMatchAll [in]

すべての検索値と一致するかどうかを指定します。

lpSearchParm [in]

検索する検索パラメーターを指定する LSLicense 構造体へのポインター。

pdwErrCode [out]

戻り値として次のいずれかのエラー コードを受け取る変数へのポインター。

LSERVER_S_SUCCESS (0)

呼び出しが成功しました。

LSERVER_E_INTERNAL_ERROR (5001)

ライセンス サーバーの内部エラー。

LSERVER_E_INVALID_SEQUENCE (5006)

呼び出し元のシーケンスが無効でした。 ほとんどの場合、前の列挙体は終了していません。

LSERVER_E_SERVER_BUSY (5007)

ライセンス サーバーがビジー状態で要求を処理しません。

LSERVER_E_OUTOFMEMORY (5008)

メモリ不足のため、要求を処理できません。

LSERVER_E_INVALID_DATA (5009)

検索パラメーター内のデータが無効です。

戻り値

この関数は、次の可能な戻り値を返します。

RPC_S_OK

呼び出しは成功しました。 pdwErrCode パラメーターの値を調べて、呼び出しのリターン コードを取得します。

RPC_S_INVALID_ARG

引数が無効です。

要件

要件	値
サポートされている最小のクライアント	Windows Vista
サポートされている最小のサーバー	Windows Server 2008
[DLL]	Mstlsapi.dll

こちらもご覧ください

LSLicense

TLSConnectToLsServer

TLSLicenseEnumNext

TLSLicenseEnumEnd