SnmpFreeDescriptor 関数 (winsnmp.h)

  • [アーティクル]

[SNMP は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。

WinSNMP アプリケーションでは 、SnmpFreeDescriptor 関数を使用して、記述子オブジェクトへのアクセスが不要になったことを Microsoft WinSNMP 実装に通知します。 この WinSNMP 関数は、記述子オブジェクトに割り当てられたメモリを解放するように実装に通知します。

構文

SNMPAPI_STATUS SNMPAPI_CALL SnmpFreeDescriptor(
  [in] smiUINT32   syntax,
  [in] smiLPOPAQUE descriptor
);

パラメーター

[in] syntax

ターゲット記述子オブジェクトの構文データ型を指定します。

[in] descriptor

解放するターゲット記述子オブジェクトを含む smiOPAQUE 構造体へのポインター。

戻り値

関数が成功した場合、戻り値はSNMPAPI_SUCCESS。

関数が失敗した場合、戻り値はSNMPAPI_FAILURE。 拡張エラー情報を取得するには、セッション パラメーターに NULL 値を指定して SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことができます。

リターン コード 説明
SNMPAPI_NOT_INITIALIZED
 SnmpStartup 関数が正常に完了しませんでした。
SNMPAPI_ALLOC_ERROR
 メモリ割り当て中にエラーが発生しました。
SNMPAPI_SYNTAX_INVALID
 構文パラメーターが無効です。
SNMPAPI_OPERATION_INVALID
 記述子パラメーターが無効です。 詳細については、次の「備考」セクションを参照してください。
SNMPAPI_OTHER_ERROR
 不明または未定義のエラーが発生しました。

注釈

この実装では、可変長の出力記述子オブジェクトのメモリが割り当ておよび割り当て解除されます。 このメモリ割り当てと割り当て解除は、 SnmpFreeDescriptor 関数が提供するインターフェイスを除き、実装に制限されます。 詳細については、「 WinSNMP 記述子の解放」を参照してください。

この実装では、 記述子 パラメーターで 、SnmpFreeDescriptor の以前の呼び出しで実装によって解放されたメモリ割り当てが指定されている場合、SNMPAPI_OPERATION_INVALIDエラー コードが返されます。 記述子パラメーターで、呼び出し元の WinSNMP アプリケーションに対して実装で行わなかったメモリ割り当てが指定されている場合、関数は同じエラー コードを返します。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winsnmp.h
Library Wsnmp32.lib
[DLL] Wsnmp32.dll

こちらもご覧ください

SnmpEncodeMsg

SnmpOidCopy

SnmpStrToOid

WinSNMP 関数

WinSNMP API の概要