SmDirInitDirInstance()
stmndr は、指定されたディレクトリ インスタンス上のディレクトリ関数を呼び出す前に、このディレクトリ インスタンス初期化関数を呼び出します。この関数は、ユーザにカスタム ディレクトリに接続する機会を提供します。
casso1283
SiteMinder
は、指定されたディレクトリ インスタンス上のディレクトリ関数を呼び出す前に、このディレクトリ インスタンス初期化関数を呼び出します。この関数は、ユーザにカスタム ディレクトリに接続する機会を提供します。SiteMinder
は、ディレクトリ関数呼び出しを完了した後、SmDirReleaseInstance() を呼び出します。この関数は複数回呼び出されます。SiteMinder
は、初期化と解放の呼び出しが実行されるたびにディレクトリ接続を作成および切断することは要求しません。構文
int SM_EXTERN SmDirInitDirInstance (const Sm_Api_Context_t*lpApiContext,void*pHandle,void**ppInstanceHandle,const char*lpszUniqueKey,const char*lpszParameter,const char*lpszUsername,const char*lpszPassword,const intbRequireCredentials,const intbSecureConnection,const intnSearchResults,const intnSearchTimeout);
パラメータ | I/O | 説明 |
lpApiContext | I | API コンテキスト構造へのポインタ。 |
pHandle | I | SmDirInit() によって返されたポインタのアドレス。 |
ppInstanceHandle | O | ディレクトリ インスタンスのハンドルを設定するためにこのパラメータを使用します。たとえば、ディレクトリへの接続に関する情報を保持するために ppInstanceHandle を使用できます。ディレクトリ インスタンス ライフサイクルの最後に、 SiteMinder ポリシー サーバは SmDirReleaseInstance() を呼び出し、ユーザがハンドルを削除できるようにディレクトリ インスタンス ハンドルを渡します。 |
lpszUniqueKey | I | ディレクトリ インスタンス セッションの一意の識別子。この一意のキーは、カスタム ディレクトリ オブジェクトのオブジェクト識別子(OID)を保持します。 |
lpszParameter | I | [ SiteMinder ユーザ ディレクトリ]ダイアログ ボックスの[パラメータ]フィールドで指定される、NULL で終わる文字列。値は SmDirInit() の呼び出しのときと同じです。 |
lpszUsername | I | [ SiteMinder ユーザ ディレクトリ]ダイアログ ボックスの[認証情報と接続]タブで指定されるユーザ名が含まれる文字列。bRequireCredentials が true に設定されている場合、lpszUsername は[管理者認証情報]グループ ボックス内の[ユーザ名]フィールドの値を保持します。 |
lpszPassword | I | [ SiteMinder ユーザ ディレクトリ]ダイアログ ボックスの[認証情報と接続]タブで指定されるパスワードが含まれる文字列。bRequireCredentials が true に設定されている場合、lpszPassword は[管理者認証情報]グループ ボックス内の[パスワード]フィールドの値を保持します。 |
bRequireCredentials | I | このブール値は、ユーザ ディレクトリ アクセスに認証情報が必要かどうかを示しています。 SiteMinder 管理 UI の[管理者認証情報]グループ ボックスの[認証情報と接続]タブに[認証情報が必要]チェック ボックスがあります。このチェック ボックスをオンにすると、bRequireCredentials が true (1) に設定されます。bRequireCredentials が true に設定されると、lpszUsername と lpszPassword は [管理者認証情報]グループ ボックスの[ユーザ名]と[パスワード]のフィールドで値を保持します。SiteMinder ポリシー サーバは、ディレクトリにアクセスするためにこれらの認証情報を使用します。 |
bSecureConnection | I | このブール値は、ユーザ ディレクトリへのアクセスに SSL 接続が必要かどうかを示します。 |
nSearchResults | I | このパラメータは、ディレクトリ API による単一の検索の結果セットとして返すレコードの最大数を示します。[ SiteMinder ユーザ ディレクトリ]ダイアログ ボックス([カスタム ネームスペース]グループ ボックスの[ディレクトリのセットアップ]タブ上)に、[検索の上限]フィールドがあります。nSearchResults パラメータは、[検索の上限]フィールドの値を保持します。 |
nSearchTimeout | I | このパラメータは、ディレクトリ API が結果に対してユーザ ディレクトリの検索を停止する時間を秒単位で示します。[ SiteMinder ユーザ ディレクトリ]ダイアログ ボックス([カスタム ネームスペース]グループ ボックスの[ディレクトリのセットアップ]タブ上)に、[最大時間]フィールドがあります。nSearchResults パラメータは、[最大時間]フィールドの値を保持します。 |
戻り値
成功した場合は 0、失敗した場合は -1 を返します。
注釈
SmDirInitDirInstance() が呼び出されるときに DirHandle_t をインスタンス化します。ディレクトリ インスタンス ハンドルとユーザ インスタンス ハンドルを区別するために
nTag
を 0 に設定します。DirHandle_t によって参照されたハンドルは、後続のディレクトリ操作関数に渡されます。ハンドル値を変更できます。
SmDirReleaseInstance() が呼び出される場合に DirHandle_t を解放します。ディレクトリ インスタンス ハンドルとユーザ インスタンス ハンドルを区別するために
nTag
の値を使用します。