NetScheduleJobGetInfo

The NetScheduleJobGetInfo function retrieves information about a particular job queued on a specified computer. This function requires that the schedule service be started.

Security Requirements

Only members of the Administrators local group can successfully execute the NetScheduleJobGetInfo function on a remote server.

NET_API_STATUS NetScheduleJobGetInfo(
  LPCWSTR Servername,       
  DWORD JobId,             
  LPBYTE *PointerToBuffer  
);

Parameters

Servername

[in] Pointer to a constant Unicode string specifying the name of the remote server on which the function is to execute. The string must begin with \\. If this parameter is NULL, the local computer is used.

JobId

[in] Specifies a DWORD value that indicates the identifier of the job for which to retrieve information.

PointerToBuffer

[out] Pointer to the buffer that receives the AT_INFO structure describing the specified job. This buffer is allocated by the system and must be freed using the NetApiBufferFree function.

Return Values

If the function succeeds, the return value is NERR_Success.

If the function fails, the return value is a Win32 API error code. For a list of error codes, see Error Codes.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Unsupported.
  Header: Declared in Lmat.h; include Lm.h.
  Library: Use Netapi32.lib.

See Also

Network Management Overview, Network Management Functions, Schedule Functions, AT_INFO, NetScheduleJobEnum