Sm_AgentApi_GetSessionVariables()
既存のセッション変数の値を取得します。
casso127jpjp
既存のセッション変数の値を取得します。
構文
int Sm_AgentApi_GetSessionVariables (const void* pHandle,const Sm_AgentApi_ResourceContext_t* pResourceContext,const char* lpszSessionId,long nNumReqAttributes,Sm_AgentApi_Attribute_t* pReqAttributes,long* pRespNumAttributes,Sm_AgentApi_Attribute_t** ppRespAttributes);
パラメータ | I/O | 説明 |
pHandle
| I | Sm_AgentApi_Init() の ppHandle パラメータで返されるエージェント API セッション ハンドル。 |
pResourceContext
| I | 将来使用のために予約済みです。フィールドをすべて 0 に設定してください。 |
lpszSessionId
| I | 変数が取得されるセッションの一意の識別子。変数は、アクティブ セッションに対してのみ取得できます。 ログインに成功した後、セッション ID が Sm_AgentApi_Session_t 構造体の lpszSessionId フィールドに返されます。 |
nNumReqAttributes
| I | pReqAttributes 内の属性の配列のサイズ。 |
pReqAttributes
| 取得されるセッション変数の名前を表す属性の配列。 変数名を Sm_AgentApi_Attribute_t 構造体の lpszAttributeOid フィールドに設定してください。Sm_AgentApi_Attribute_t 構造体の nAttributeFlags フィールドを以下の値のいずれかに設定してください。SM_AGENTAPI_REQATTR_FLAGS_NONE 指定された変数を取得しますが、削除はしません。 SM_AGENTAPI_REQATTR_FLAGS_DELETE 変数を取得した後、セッション ストアから削除します。 この構造体の nAttributeId フィールドおよび nAttributeTTL フィールドは無視されます。Sm_AgentApi_Attribute_t 構造体の nAttributeFlags フィールドを以下の値のいずれかに設定してください。SM_AGENTAPI_REQATTR_FLAGS_NONE 指定された変数を取得しますが、削除はしません。 SM_AGENTAPI_REQATTR_FLAGS_DELETE 変数を取得した後、セッション ストアから削除します。 この構造体の nAttributeId フィールドおよび nAttributeTTL フィールドは無視されます。 | |
pRespNumAttributes
| O | ppRespAttributes 内のレスポンスの配列のサイズ。 |
ppRespAttributes
| O | セッション変数およびそれらの値を表すレスポンス属性の配列。 この関数から返された値は、レスポンス属性の結果セットの内容を以下のように示します。 SM_AGENTAPI_UNRESOLVED いくつかの変数をフェッチできませんでした。特定の変数をフェッチできない場合、Sm_AgentApi_Attribute_t 構造体の関連する nAttributeFlags フィールドが SM_AGENTAPI_ RESPATTR_FLAGS_UNRESOLVED に設定されます。取得される変数に対応する nAttributeFlags フィールドは SM_AGENTAPI_RESPATTR_FLAGS_NONE に設定されます。SM_AGENTAPI_YES すべての要求された変数それらの値がセッション ストアから取得され、 ppRespAttributes で返されました。この構造体の nAttributeId フィールドおよび nAttributeTTL フィールドは無視されます。 |
戻り値
- SM_AGENTAPI_YES。操作は成功しました。
- SM_AGENTAPI_NO。コールは拒否されました。
- SM_AGENTAPI_UNRESOLVED。いくつかの変数をフェッチできませんでした。ppRespAttributesパラメータの説明を参照してください。
- SM_AGENTAPI_NOCONNECTION。初期化できませんでした。
- SM_AGENTAPI_FAILURE。サーバにアクセスできませんでした。
- SM_AGENTAPI_TIMEOUT。関数がタイム アウトしました。
- SM_AGENTAPI_SUCCESS。操作は成功しました。
注釈
lpszSessionId
によって参照されるセッションがアクティブでない場合、変数が検索されない場合、またはセッション ストアへの接続が失われている場合、この関数は失敗します。変数をフェッチした後にセッション ストアから削除するには、
pReqAttributes
パラメータの SM_AGENTAPI_REQATTR_FLAGS_DELETE フラグを設定します。変数をフェッチせずにセッション ストアから削除するには、Sm_AgentApi_DelSessionVariables() 関数をコールします。ppRespAttributes
パラメータで返された変数に対して割り当てられたメモリを解放するには、Sm_AgentApi_FreeAttributes() をコールします。