Sm_AgentApi_SetSessionVariables()
新しいセッション変数を作成するか、または既存のセッション変数を更新します。
casso127jpjp
新しいセッション変数を作成するか、または既存のセッション変数を更新します。
構文
int Sm_AgentApi_SetSessionVariables (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
| I | セッション変数の値を表す属性の配列。 変数名を構造体 Sm_AgentApi_Attribute_t の lpszAttributeOid フィールドに設定してください。変数名がすでに存在する場合、関連する変数値が pReqAttributes の値によって上書きされます。変数名が存在しない場合、新しい変数が作成されます。 Sm_AgentApi_Attribute_t 構造体の nAttributeFlags フィールドを SM_AGENTAPI_REQATTR_FLAGS_NONE に設定してください。この構造体の nAttributeId フィールドおよび nAttributeTTL フィールドは無視されます。 |
pRespNumAttributes
| O | ppRespAttributes 内のレスポンスの配列のサイズ。 |
ppRespAttributes
| O | 設定できなかった変数を表すレスポンス属性の配列。 この関数が SM_AGENTAPI_UNRESOLVED を返す場合、レスポンス属性の結果セットには未解決の変数が含まれます。また、返された未解決の変数ごとに、Sm_AgentApi_Attribute_t 構造体の nAttributeFlags フィールドが SM_AGENTAPI_RESPATTR_UNRESOLVED に設定されます。この構造体の 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
によって参照されるセッションがアクティブでない場合やセッション ストアへの接続が失われている場合、この関数は失敗します。ppRespAttributes
パラメータで返された未解決の変数値に対して割り当てられたメモリを解放するには、Sm_AgentApi_FreeAttributes() をコールします。