WinSNMP 関数

  • [アーティクル]

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

WinSNMP で使用される関数は、次の機能グループに分類されます。 アルファベット順の一覧が続きます。

WinSNMP 通信関数

WinSNMP 通信関数は、呼び出し元の WinSNMP アプリケーションと Microsoft WinSNMP 実装の間のインターフェイスを提供します。 実装は、アプリケーションと他の管理エンティティ間の通信を処理します。

機能 説明
SnmpCancelMsg Microsoft WinSNMP 実装が SNMP 要求メッセージの再送信試行とタイムアウト通知を取り消すよう要求します。
SnmpCleanup アプリケーションが切断され、割り当てられたリソースが不要になっていることを実装に通知します。
SnmpCleanupEx WinSNMP アプリケーション内で SnmpStartup または SnmpStartupEx への未処理の正常な呼び出しがない場合にクリーンアップを実行します。
SnmpClose 実装でセッションに関連付けられているリソースの割り当てを解除し、通信メカニズムを閉じできるようにします。
SnmpCreateSession WinSNMP セッションを開き、リソースと通信メカニズムを割り当てる実装を要求します。 新しい WinSNMP アプリケーションを開発するときは、SnmpOpen 関数を呼び出す代わりに SnmpCreateSession関数を 呼び出して WinSNMP セッションを開くことをお勧めします。
SnmpListen WinSNMP アプリケーションを SNMP エージェントとして登録または登録解除します。
SnmpOpen WinSNMP セッションを開き、リソースと通信メカニズムを割り当てる実装を要求します。 新しい WinSNMP アプリケーションを開発するときは、SnmpOpen 関数を呼び出す代わりに SnmpCreateSession関数を 呼び出して WinSNMP セッションを開くことをお勧めします。
SnmpRecvMsg SNMP メッセージと未処理のトラップ データと通知を返します。
SnmpRegister アプリケーションがトラップと通知を登録または登録解除する必要があることを実装に通知します。
SnmpSendMsg 実装がプロトコル データ ユニットを送信することを要求します。
SnmpStartup アプリケーションの初期化手順を実行するように実装に通知します。 アプリケーションは、他の WinSNMP 関数を呼び出す前に 、SnmpStartup 関数を正常に呼び出す必要があります。
SnmpStartupEx WinSNMP アプリケーションに実装のサービスが必要であることを Microsoft WinSNMP 実装に通知します。 SnmpStartupEx を使用すると、同じアプリケーション内で WinSNMP を使用する複数の独立したソフトウェア モジュールをサポートできます。
SNMPAPI_CALLBACK SNMP メッセージまたは非同期イベントが使用可能であることを WinSNMP セッションに通知します。 メモ： このコールバック関数は、 SnmpCreateSession 関数の呼び出しの結果として開かれたセッションにのみ適用されます。

WinSNMP エンティティ関数とコンテキスト関数

WinSNMP エンティティとコンテキスト関数を使用すると、WinSNMP アプリケーションで SNMP エンティティとコンテキストのわかりやすい名前を指定できます。 Microsoft WinSNMP 実装は、その実装のデータベースを使用して、名前を SNMPv1 または SNMPv2C コンポーネントに変換します。

機能 説明
SnmpContextToStr SNMP コンテキスト (マネージド オブジェクト リソースのセット) を識別する文字列を返します。
SnmpEntityToStr SNMP 管理エンティティを識別する文字列を返します。
SnmpFreeContext SNMP コンテキストに対して SnmpStrToContext 関数によって割り当てられたリソースを解放します。
SnmpFreeEntity SNMP 管理エンティティの SnmpStrToEntity 関数によって割り当てられたリソースを解放します。
SnmpSetPort SNMP 宛先エンティティに割り当てられたポートを変更します。
SnmpStrToContext 実装に固有の SNMP コンテキスト情報へのハンドルを返します。
SnmpStrToEntity 実装に固有の SNMP 管理エンティティ情報へのハンドルを返します。

WinSNMP データベース関数

WinSNMP データベース関数は、Microsoft WinSNMP 実装の管理情報ストアの現在の設定にアクセスできる WinSNMP アプリケーションを提供します。 これらの関数を使用すると、再送信モードとエンティティおよびコンテキスト変換モードを変更できます。 データベース関数は、タイムアウトと再試行回数の値を操作する機能もアプリケーションに提供します。

機能 説明
SnmpGetRetransmitMode 再送信モードの現在の設定を返します。
SnmpGetRetry SNMP メッセージ要求の再送信の再試行回数の値を単位で返します。
SnmpGetTimeout SNMP メッセージ要求の送信のタイムアウト値を 100 分の 1 秒で返します。
SnmpGetTranslateMode エンティティとコンテキスト翻訳モードの現在の設定を返します。
SnmpGetVendorInfo WinSNMP ベンダーを識別する情報を取得します。
SnmpSetRetransmitMode 再送信モードを変更します。
SnmpSetRetry SNMP メッセージ要求の再送信の再試行回数の値を変更します。
SnmpSetTimeout SNMP メッセージ要求の送信のタイムアウト値を変更します。
SnmpSetTranslateMode エンティティとコンテキスト変換モードを変更します。

WinSNMP PDU 関数

WinSNMP PDU 関数を使用すると、WinSNMP アプリケーションで PDU のデータ要素 (またはフィールド) を抽出および更新できます。 これには、 SnmpRecvMsg 関数または SnmpDecodeMsg 関数の呼び出しによって返される PDU が 含まれます。 また、PDU 関数は、SnmpSendMsg 関数と SnmpEncodeMsg 関数で使用する PDU も構築します。

機能 説明
SnmpCreatePdu SNMP プロトコル データ ユニットを作成して初期化します。
SnmpDuplicatePdu SNMP プロトコル データ ユニットを複製します。
SnmpFreePdu SnmpCreatePdu または SnmpDuplicatePdu 関数によって作成された SNMP プロトコル データ ユニットに関連付けられているリソースを解放します。
SnmpGetPduData 指定した SNMP プロトコル データ ユニットから選択したデータ要素を返します。
SnmpSetPduData 更新指定された SNMP プロトコル・データ・ユニット内の選択されたデータ要素です。

WinSNMP ユーティリティ関数

WinSNMP ユーティリティ関数を使用すると、WinSNMP アプリケーションで WinSNMP インターフェイス全体のオブジェクトと SNMP メッセージを管理できます。

機能 説明
SnmpDecodeMsg エンコードまたはシリアル化された SNMP メッセージを構成要素にデコードします。
SnmpEncodeMsg エンコードされた SNMP メッセージを作成します。
SnmpFreeDescriptor 特定の記述子に割り当てられたメモリを解放する必要があることを Microsoft WinSNMP 実装に通知します。
SnmpGetLastError 最後の SNMP 操作の最後のエラー コード値を返します。
SnmpOidCompare 2 つの SNMP オブジェクト識別子を比較します。
SnmpOidCopy SNMP オブジェクト識別子をコピーします。
SnmpOidToStr SNMP オブジェクト識別子の内部バイナリ表現を点線の数値文字列形式に変換します。
SnmpStrToOid SNMP オブジェクト識別子の点線の数値文字列形式を内部バイナリ表現に変換します。

WinSNMP 変数バインド関数

WinSNMP 変数バインド関数を使用すると、WinSNMP アプリケーションで変数バインド リストを構築および操作し、それらを PPDU に含めることができます。

機能 説明
SnmpCountVbl 指定した変数バインド リスト内の変数バインド エントリを列挙します。
SnmpCreateVbl 新しい変数バインド リストを作成します。
SnmpDeleteVb 変数バインド リストから変数バインド エントリを削除します。
SnmpDuplicateVbl 変数バインド リストをコピーします。
SnmpFreeVbl SnmpCreateVbl または SnmpDuplicateVbl 関数によって以前に割り当てられた変数バインディング リストのリソースを解放します。
SnmpGetVb 指定した変数バインド エントリから情報を取得します。
SnmpSetVb 変数バインド リスト内の変数バインド エントリを変更します。は、既存の変数バインド リストに新しい変数バインド エントリを追加します。

WinSNMP 関数のアルファベット順リスト