Sm_AgentApi_DelSessionVariables()
指定されたセッション変数をセッション ストアから削除します。
casso127jpjp
指定されたセッション変数をセッション ストアから削除します。
構文
int Sm_AgentApi_DelSessionVariables (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 フィールドに設定してください。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_FLAGS_UNRESOLVED に設定されます。この構造体の nAttributeId フィールドおよび nAttributeTTL フィールドは無視されます。 |
戻り値
- SM_AGENTAPI_YES。操作は成功しました。
- SM_AGENTAPI_NO。コールは拒否されました。
- SM_AGENTAPI_UNRESOLVED。いくつかの変数を削除できませんでした。ppRespAttributesパラメータの説明を参照してください。
- SM_AGENTAPI_NOCONNECTION。初期化できませんでした。
- SM_AGENTAPI_FAILURE。サーバにアクセスできませんでした。
- SM_AGENTAPI_TIMEOUT。関数がタイム アウトしました。
注釈
lpszSessionId
によって参照されるセッションがアクティブでない場合やセッション ストアへの接続が失われている場合、この関数は失敗します。ppRespAttributes
パラメータで返された変数に対して割り当てられたメモリを解放するには、Sm_AgentApi_FreeAttributes() をコールします。