ホーム › NetworkManagement.NetManagement › NetScheduleJobEnum

NetScheduleJobEnum

関数

スケジュールキュー内のジョブ一覧を列挙する。

DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// NETAPI32.dll
#include <windows.h>

DWORD NetScheduleJobEnum(
    LPCWSTR Servername,
    BYTE** PointerToBuffer,
    DWORD PrefferedMaximumLength,
    DWORD* EntriesRead,
    DWORD* TotalEntries,
    DWORD* ResumeHandle
);

パラメーター

名前	型	方向	説明
Servername	LPCWSTR	in	関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する定数文字列へのポインターです。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。
PointerToBuffer	BYTE**	inout	データを受け取るバッファーへのポインターです。返される情報は AT_ENUM 構造体の配列です。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数の 1 回の呼び出しで解放する必要があります。関数が ERROR_MORE_DATA で失敗した場合でも、バッファーを解放する必要があることに注意してください。
PrefferedMaximumLength	DWORD	in	返されるデータの推奨される最大長をバイト単位で示す値です。MAX_PREFERRED_LENGTH を指定すると、関数はデータに必要な量のメモリを割り当てます。このパラメーターに別の値を指定すると、関数が返すバイト数を制限できます。バッファーサイズがすべてのエントリを保持するのに不十分な場合、関数は ERROR_MORE_DATA を返します。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。
EntriesRead	DWORD*	inout	実際に列挙された要素の数を受け取る値へのポインターです。
TotalEntries	DWORD*	inout	現在の再開位置から列挙できたであろうエントリの総数を受け取る値へのポインターです。アプリケーションはこの値を目安としてのみ扱う必要があることに注意してください。
ResumeHandle	DWORD*	inout	ジョブの列挙を継続するために使用される再開ハンドルを格納する値へのポインターです。このハンドルは最初の呼び出しではゼロにし、以降の呼び出しでは変更せずに渡す必要があります。このパラメーターが NULL の場合、再開ハンドルは格納されません。

戻り値の型: DWORD

公式ドキュメント

NetScheduleJobEnum 関数は、指定したコンピューター上でキューに登録されているジョブを列挙します。この関数を使用するには、スケジュールサービスが開始されている必要があります。

戻り値

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

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

解説(Remarks)

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

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

HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// NETAPI32.dll
#include <windows.h>

DWORD NetScheduleJobEnum(
    LPCWSTR Servername,
    BYTE** PointerToBuffer,
    DWORD PrefferedMaximumLength,
    DWORD* EntriesRead,
    DWORD* TotalEntries,
    DWORD* ResumeHandle
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetScheduleJobEnum(
    [MarshalAs(UnmanagedType.LPWStr)] string Servername,   // LPCWSTR
    IntPtr PointerToBuffer,   // BYTE** in/out
    uint PrefferedMaximumLength,   // DWORD
    ref uint EntriesRead,   // DWORD* in/out
    ref uint TotalEntries,   // DWORD* in/out
    ref uint ResumeHandle   // DWORD* in/out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetScheduleJobEnum(
    <MarshalAs(UnmanagedType.LPWStr)> Servername As String,   ' LPCWSTR
    PointerToBuffer As IntPtr,   ' BYTE** in/out
    PrefferedMaximumLength As UInteger,   ' DWORD
    ByRef EntriesRead As UInteger,   ' DWORD* in/out
    ByRef TotalEntries As UInteger,   ' DWORD* in/out
    ByRef ResumeHandle As UInteger   ' DWORD* in/out
) As UInteger
End Function

' Servername : LPCWSTR
' PointerToBuffer : BYTE** in/out
' PrefferedMaximumLength : DWORD
' EntriesRead : DWORD* in/out
' TotalEntries : DWORD* in/out
' ResumeHandle : DWORD* in/out
Declare PtrSafe Function NetScheduleJobEnum Lib "netapi32" ( _
    ByVal Servername As LongPtr, _
    ByVal PointerToBuffer As LongPtr, _
    ByVal PrefferedMaximumLength As Long, _
    ByRef EntriesRead As Long, _
    ByRef TotalEntries As Long, _
    ByRef ResumeHandle As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetScheduleJobEnum = ctypes.windll.netapi32.NetScheduleJobEnum
NetScheduleJobEnum.restype = wintypes.DWORD
NetScheduleJobEnum.argtypes = [
    wintypes.LPCWSTR,  # Servername : LPCWSTR
    ctypes.c_void_p,  # PointerToBuffer : BYTE** in/out
    wintypes.DWORD,  # PrefferedMaximumLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # EntriesRead : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # TotalEntries : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # ResumeHandle : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetScheduleJobEnum = Fiddle::Function.new(
  lib['NetScheduleJobEnum'],
  [
    Fiddle::TYPE_VOIDP,  # Servername : LPCWSTR
    Fiddle::TYPE_VOIDP,  # PointerToBuffer : BYTE** in/out
    -Fiddle::TYPE_INT,  # PrefferedMaximumLength : DWORD
    Fiddle::TYPE_VOIDP,  # EntriesRead : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # TotalEntries : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ResumeHandle : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetScheduleJobEnum(
        Servername: *const u16,  // LPCWSTR
        PointerToBuffer: *mut *mut u8,  // BYTE** in/out
        PrefferedMaximumLength: u32,  // DWORD
        EntriesRead: *mut u32,  // DWORD* in/out
        TotalEntries: *mut u32,  // DWORD* in/out
        ResumeHandle: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetScheduleJobEnum([MarshalAs(UnmanagedType.LPWStr)] string Servername, IntPtr PointerToBuffer, uint PrefferedMaximumLength, ref uint EntriesRead, ref uint TotalEntries, ref uint ResumeHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetScheduleJobEnum' -Namespace Win32 -PassThru
# $api::NetScheduleJobEnum(Servername, PointerToBuffer, PrefferedMaximumLength, EntriesRead, TotalEntries, ResumeHandle)

#uselib "NETAPI32.dll"
#func global NetScheduleJobEnum "NetScheduleJobEnum" sptr, sptr, sptr, sptr, sptr, sptr
; NetScheduleJobEnum Servername, varptr(PointerToBuffer), PrefferedMaximumLength, varptr(EntriesRead), varptr(TotalEntries), varptr(ResumeHandle)   ; 戻り値は stat
; Servername : LPCWSTR -> "sptr"
; PointerToBuffer : BYTE** in/out -> "sptr"
; PrefferedMaximumLength : DWORD -> "sptr"
; EntriesRead : DWORD* in/out -> "sptr"
; TotalEntries : DWORD* in/out -> "sptr"
; ResumeHandle : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "NETAPI32.dll"
#cfunc global NetScheduleJobEnum "NetScheduleJobEnum" wstr, var, int, var, var, var
; res = NetScheduleJobEnum(Servername, PointerToBuffer, PrefferedMaximumLength, EntriesRead, TotalEntries, ResumeHandle)
; Servername : LPCWSTR -> "wstr"
; PointerToBuffer : BYTE** in/out -> "var"
; PrefferedMaximumLength : DWORD -> "int"
; EntriesRead : DWORD* in/out -> "var"
; TotalEntries : DWORD* in/out -> "var"
; ResumeHandle : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NETAPI32.dll"
#cfunc global NetScheduleJobEnum "NetScheduleJobEnum" wstr, sptr, int, sptr, sptr, sptr
; res = NetScheduleJobEnum(Servername, varptr(PointerToBuffer), PrefferedMaximumLength, varptr(EntriesRead), varptr(TotalEntries), varptr(ResumeHandle))
; Servername : LPCWSTR -> "wstr"
; PointerToBuffer : BYTE** in/out -> "sptr"
; PrefferedMaximumLength : DWORD -> "int"
; EntriesRead : DWORD* in/out -> "sptr"
; TotalEntries : DWORD* in/out -> "sptr"
; ResumeHandle : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。