ホーム › NetworkManagement.NetManagement › NetRemoteTOD

NetRemoteTOD

関数

リモートサーバーの時刻情報を取得する。

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

シグネチャ

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

DWORD NetRemoteTOD(
    LPCWSTR UncServerName,   // optional
    BYTE** BufferPtr
);

パラメーター

名前	型	方向	説明
UncServerName	LPCWSTR	inoptional	関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する定数文字列へのポインターです。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。
BufferPtr	BYTE**	out	TIME_OF_DAY_INFO 情報構造体を受け取るアドレスへのポインターです。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。

戻り値の型: DWORD

公式ドキュメント

NetRemoteTOD 関数は、指定したサーバーから時刻情報を取得します。

戻り値

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

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

解説(Remarks)

NetRemoteTOD 関数を正常に実行するために、特別なグループメンバーシップは必要ありません。

Examples

次のコードサンプルは、 NetRemoteTOD 関数の呼び出しによって現在の日付と時刻を取得して表示する方法を示しています。これを行うために、サンプルでは TIME_OF_DAY_INFO 構造体を使用します。最後に、サンプルは情報バッファーに割り当てられたメモリを解放します。

#include <stdio.h>
#include <windows.h> 
#include <lm.h>
#pragma comment(lib, "netapi32.lib")

#ifndef UNICODE
#define UNICODE
#endif

int wmain(int argc, wchar_t *argv[])
{
   LPTIME_OF_DAY_INFO pBuf = NULL;
   NET_API_STATUS nStatus;
   LPTSTR pszServerName = NULL;

   if (argc > 2)
   {
      fwprintf(stderr, L"Usage: %s [\\\\ServerName]\n", argv[0]);
      exit(1);
   }
   // The server is not the default local computer.
   //
   if (argc == 2)
      pszServerName = (LPTSTR) argv[1];
   //
   // Call the NetRemoteTOD function.
   //
   nStatus = NetRemoteTOD((LPCWSTR) pszServerName,
                          (LPBYTE *)&pBuf);
   //
   // If the function succeeds, display the current date and time.
   //
   if (nStatus == NERR_Success)
   {
      if (pBuf != NULL)
      {
         fprintf(stderr, "\nThe current date is: %d/%d/%d\n",
                 pBuf->tod_month, pBuf->tod_day, pBuf->tod_year);
         fprintf(stderr, "The current time is: %d:%d:%d\n",
                 pBuf->tod_hours, pBuf->tod_mins, pBuf->tod_secs);
      }
   }
   //
   // Otherwise, display a system error.
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);
   //
   // Free the allocated buffer.
   //
   if (pBuf != NULL)
      NetApiBufferFree(pBuf);

   return 0;
}

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

各言語での呼び出し定義

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

DWORD NetRemoteTOD(
    LPCWSTR UncServerName,   // optional
    BYTE** BufferPtr
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetRemoteTOD(
    [MarshalAs(UnmanagedType.LPWStr)] string UncServerName,   // LPCWSTR optional
    IntPtr BufferPtr   // BYTE** out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetRemoteTOD(
    <MarshalAs(UnmanagedType.LPWStr)> UncServerName As String,   ' LPCWSTR optional
    BufferPtr As IntPtr   ' BYTE** out
) As UInteger
End Function

' UncServerName : LPCWSTR optional
' BufferPtr : BYTE** out
Declare PtrSafe Function NetRemoteTOD Lib "netapi32" ( _
    ByVal UncServerName As LongPtr, _
    ByVal BufferPtr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetRemoteTOD = ctypes.windll.netapi32.NetRemoteTOD
NetRemoteTOD.restype = wintypes.DWORD
NetRemoteTOD.argtypes = [
    wintypes.LPCWSTR,  # UncServerName : LPCWSTR optional
    ctypes.c_void_p,  # BufferPtr : BYTE** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetRemoteTOD = Fiddle::Function.new(
  lib['NetRemoteTOD'],
  [
    Fiddle::TYPE_VOIDP,  # UncServerName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # BufferPtr : BYTE** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetRemoteTOD(
        UncServerName: *const u16,  // LPCWSTR optional
        BufferPtr: *mut *mut u8  // BYTE** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetRemoteTOD([MarshalAs(UnmanagedType.LPWStr)] string UncServerName, IntPtr BufferPtr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetRemoteTOD' -Namespace Win32 -PassThru
# $api::NetRemoteTOD(UncServerName, BufferPtr)

#uselib "NETAPI32.dll"
#func global NetRemoteTOD "NetRemoteTOD" sptr, sptr
; NetRemoteTOD UncServerName, varptr(BufferPtr)   ; 戻り値は stat
; UncServerName : LPCWSTR optional -> "sptr"
; BufferPtr : BYTE** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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