NetScheduleJobEnum 関数 (lmat.h)

[アーティクル]
08/24/2023

[NetScheduleJobEnum は、Windows 8の時点で使用できなくなりました。代わりに、タスクスケジューラ 2.0 インターフェイスを使用します。

]

NetScheduleJobEnum 関数は、指定したコンピューターでキューに入れられたジョブを一覧表示します。この関数では、スケジュールサービスを開始する必要があります。

構文

NET_API_STATUS NET_API_FUNCTION NetScheduleJobEnum(
  [in, optional] LPCWSTR Servername,
  [out]          LPBYTE  *PointerToBuffer,
  [in]           DWORD   PrefferedMaximumLength,
  [out]          LPDWORD EntriesRead,
  [out]          LPDWORD TotalEntries,
  [in, out]      LPDWORD ResumeHandle
);

パラメーター

[in, optional] Servername

関数を実行するリモートサーバーの DNS または NetBIOS 名を指定する定数文字列へのポインター。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。

[out] PointerToBuffer

データを受信するバッファーへのポインター。戻り値の情報は、 AT_ENUM 構造体の配列です。バッファーはシステムによって割り当てられ、 NetApiBufferFree 関数の 1 回の呼び出しを使用して解放する必要があります。関数が ERROR_MORE_DATA で失敗した場合でも、バッファーを解放する必要があることに注意してください。

[in] PrefferedMaximumLength

返されるデータの推奨される最大長をバイト単位で示す値。 MAX_PREFERRED_LENGTHを指定した場合、関数はデータに必要なメモリ量を割り当てます。このパラメーターに別の値を指定すると、関数から返されるバイト数を制限できます。バッファーサイズが不十分で、すべてのエントリを保持できる場合、関数は ERROR_MORE_DATAを返します。詳細については、「ネットワーク管理機能バッファー」および「ネットワーク管理機能バッファーの長さ」を参照してください。

[out] EntriesRead

実際に列挙された要素の数を受け取る値へのポインター。

[out] TotalEntries

現在の再開位置から列挙された可能性のあるエントリの合計数を受け取る値へのポインター。アプリケーションでは、この値のみをヒントとして考慮する必要があることに注意してください。

[in, out] ResumeHandle

ジョブ列挙を続行するために使用される再開ハンドルを含む値へのポインター。最初の呼び出しではハンドルを 0 にし、後続の呼び出しでは変更せずに残す必要があります。このパラメーターが NULL の場合、再開ハンドルは格納されません。

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードです。エラーコードの一覧については、「システムエラーコード」を参照してください。

注釈

通常、スケジュールジョブが列挙されているコンピューター上のローカル Administrators グループのメンバーのみが、この関数を正常に実行できます。 Servername パラメーターが指す文字列で渡されたサーバー名がリモートサーバーの場合、サーバー上のローカル Administrators グループのメンバーのみが正常にこの関数を実行できます。

次のレジストリ値に最下位ビットが設定されている場合 (たとえば、0x00000001)、サーバーオペレーターグループに属するユーザーもこの関数を正常に実行できます。

HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl

返される各エントリには、 AT_ENUM 構造体が含まれています。 JobId メンバーの値は、NetScheduleJobDel 関数などのジョブ識別子パラメーターを必要とする関数を呼び出すときに使用できます。

要件

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