Win32 API 日本語リファレンス
ホームSystem.Rpc › RpcNsMgmtSetExpAge

RpcNsMgmtSetExpAge

関数
名前サービスの既定のキャッシュ有効期限を設定する。
DLLRPCNS4.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

RPC_STATUS RpcNsMgmtSetExpAge(
    DWORD ExpirationAge
);

パラメーター

名前方向説明
ExpirationAgeDWORDin

既定の有効期限 (秒単位) へのポインター。この値は、すべてのネームサービスの next 操作で使用されます。有効期限に 0 を指定すると、ローカルのネームサービスデータが直ちに更新されます。

有効期限を RPC 既定値の 2 時間にリセットするには、RPC_C_NS_DEFAULT_EXP_AGE を指定します。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcNsMgmtSetExpAge 関数は、ネームサービスデータのローカルコピーに対するアプリケーション全体の有効期限を変更します。

戻り値

説明
RPC_S_OK
呼び出しに成功しました。
RPC_S_NAME_SERVICE_UNAVAILABLE
ネームサービスが利用できません。
注意 有効なエラーコードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

RpcNsMgmtSetExpAge 関数は、アプリケーションのグローバルな有効期限を変更します。有効期限とは、ネームサービス属性から取得したデータのローカルコピーが、アプリケーションからその属性への要求によってローカルコピーの更新が必要になるまでの間、保持され続ける時間のことです。アプリケーションの実行が開始されると、RPC ランタイムライブラリは既定の有効期限として 2 時間を設定します。この既定値はアプリケーション全体に適用されます。通常は RpcNsMgmtSetExpAge の使用を避け、既定の有効期限に任せることをお勧めします。

有効期限は、Pointer の next 操作 (ネームサービス属性からデータを読み取る操作) で使用されます。next 操作は通常、アプリケーションが要求している属性データのローカルコピーを探すことから始まります。ローカルコピーが存在しない場合、next 操作はネームサービスデータベースから最新の属性データを取得してローカルコピーを作成します。ローカルコピーが既に存在する場合は、その実際の経過時間とアプリケーションが使用している有効期限とを比較します。実際の経過時間が有効期限を超えている場合、操作は自動的に最新の属性データでローカルコピーを更新しようとします。更新できない場合は、古いローカルデータがそのまま残り、next 操作は失敗して RPC_S_NAME_SERVICE_UNAVAILABLE 状態コードを返します。

有効期限を小さな値に設定すると、Pointer の next 操作は、アプリケーションが要求するネームサービス属性のローカルデータを頻繁に更新するようになります。たとえば、有効期限を 0 に設定すると、すべての next 操作が、アプリケーションの要求したネームサービス属性のローカルデータを強制的に更新します。そのため、有効期限を小さく設定すると、アプリケーションのパフォーマンス上の問題を引き起こしたり、ネットワークトラフィックを増加させたりする可能性があります。さらに、アプリケーションがリモートのネームサービスサーバーを使用している場合、有効期限が小さいと、すべてのアプリケーションのネットワークパフォーマンスに悪影響を及ぼすおそれがあります。

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

各言語での呼び出し定義

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

RPC_STATUS RpcNsMgmtSetExpAge(
    DWORD ExpirationAge
);
[DllImport("RPCNS4.dll", ExactSpelling = true)]
static extern int RpcNsMgmtSetExpAge(
    uint ExpirationAge   // DWORD
);
<DllImport("RPCNS4.dll", ExactSpelling:=True)>
Public Shared Function RpcNsMgmtSetExpAge(
    ExpirationAge As UInteger   ' DWORD
) As Integer
End Function
' ExpirationAge : DWORD
Declare PtrSafe Function RpcNsMgmtSetExpAge Lib "rpcns4" ( _
    ByVal ExpirationAge As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RpcNsMgmtSetExpAge = ctypes.windll.rpcns4.RpcNsMgmtSetExpAge
RpcNsMgmtSetExpAge.restype = ctypes.c_int
RpcNsMgmtSetExpAge.argtypes = [
    wintypes.DWORD,  # ExpirationAge : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCNS4.dll')
RpcNsMgmtSetExpAge = Fiddle::Function.new(
  lib['RpcNsMgmtSetExpAge'],
  [
    -Fiddle::TYPE_INT,  # ExpirationAge : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "rpcns4")]
extern "system" {
    fn RpcNsMgmtSetExpAge(
        ExpirationAge: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RPCNS4.dll")]
public static extern int RpcNsMgmtSetExpAge(uint ExpirationAge);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCNS4_RpcNsMgmtSetExpAge' -Namespace Win32 -PassThru
# $api::RpcNsMgmtSetExpAge(ExpirationAge)
#uselib "RPCNS4.dll"
#func global RpcNsMgmtSetExpAge "RpcNsMgmtSetExpAge" sptr
; RpcNsMgmtSetExpAge ExpirationAge   ; 戻り値は stat
; ExpirationAge : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RPCNS4.dll"
#cfunc global RpcNsMgmtSetExpAge "RpcNsMgmtSetExpAge" int
; res = RpcNsMgmtSetExpAge(ExpirationAge)
; ExpirationAge : DWORD -> "int"
; RPC_STATUS RpcNsMgmtSetExpAge(DWORD ExpirationAge)
#uselib "RPCNS4.dll"
#cfunc global RpcNsMgmtSetExpAge "RpcNsMgmtSetExpAge" int
; res = RpcNsMgmtSetExpAge(ExpirationAge)
; ExpirationAge : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rpcns4 = windows.NewLazySystemDLL("RPCNS4.dll")
	procRpcNsMgmtSetExpAge = rpcns4.NewProc("RpcNsMgmtSetExpAge")
)

// ExpirationAge (DWORD)
r1, _, err := procRpcNsMgmtSetExpAge.Call(
	uintptr(ExpirationAge),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // RPC_STATUS
function RpcNsMgmtSetExpAge(
  ExpirationAge: DWORD   // DWORD
): Integer; stdcall;
  external 'RPCNS4.dll' name 'RpcNsMgmtSetExpAge';
result := DllCall("RPCNS4\RpcNsMgmtSetExpAge"
    , "UInt", ExpirationAge   ; DWORD
    , "Int")   ; return: RPC_STATUS
●RpcNsMgmtSetExpAge(ExpirationAge) = DLL("RPCNS4.dll", "int RpcNsMgmtSetExpAge(dword)")
# 呼び出し: RpcNsMgmtSetExpAge(ExpirationAge)
# ExpirationAge : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "rpcns4" fn RpcNsMgmtSetExpAge(
    ExpirationAge: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc RpcNsMgmtSetExpAge(
    ExpirationAge: uint32  # DWORD
): int32 {.importc: "RpcNsMgmtSetExpAge", stdcall, dynlib: "RPCNS4.dll".}
pragma(lib, "rpcns4");
extern(Windows)
int RpcNsMgmtSetExpAge(
    uint ExpirationAge   // DWORD
);
ccall((:RpcNsMgmtSetExpAge, "RPCNS4.dll"), stdcall, Int32,
      (UInt32,),
      ExpirationAge)
# ExpirationAge : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t RpcNsMgmtSetExpAge(
    uint32_t ExpirationAge);
]]
local rpcns4 = ffi.load("rpcns4")
-- rpcns4.RpcNsMgmtSetExpAge(ExpirationAge)
-- ExpirationAge : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('RPCNS4.dll');
const RpcNsMgmtSetExpAge = lib.func('__stdcall', 'RpcNsMgmtSetExpAge', 'int32_t', ['uint32_t']);
// RpcNsMgmtSetExpAge(ExpirationAge)
// ExpirationAge : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("RPCNS4.dll", {
  RpcNsMgmtSetExpAge: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.RpcNsMgmtSetExpAge(ExpirationAge)
// ExpirationAge : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RpcNsMgmtSetExpAge(
    uint32_t ExpirationAge);
C, "RPCNS4.dll");
// $ffi->RpcNsMgmtSetExpAge(ExpirationAge);
// ExpirationAge : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Rpcns4 extends StdCallLibrary {
    Rpcns4 INSTANCE = Native.load("rpcns4", Rpcns4.class);
    int RpcNsMgmtSetExpAge(
        int ExpirationAge   // DWORD
    );
}
@[Link("rpcns4")]
lib LibRPCNS4
  fun RpcNsMgmtSetExpAge = RpcNsMgmtSetExpAge(
    ExpirationAge : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RpcNsMgmtSetExpAgeNative = Int32 Function(Uint32);
typedef RpcNsMgmtSetExpAgeDart = int Function(int);
final RpcNsMgmtSetExpAge = DynamicLibrary.open('RPCNS4.dll')
    .lookupFunction<RpcNsMgmtSetExpAgeNative, RpcNsMgmtSetExpAgeDart>('RpcNsMgmtSetExpAge');
// ExpirationAge : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RpcNsMgmtSetExpAge(
  ExpirationAge: DWORD   // DWORD
): Integer; stdcall;
  external 'RPCNS4.dll' name 'RpcNsMgmtSetExpAge';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RpcNsMgmtSetExpAge"
  c_RpcNsMgmtSetExpAge :: Word32 -> IO Int32
-- ExpirationAge : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rpcnsmgmtsetexpage =
  foreign "RpcNsMgmtSetExpAge"
    (uint32_t @-> returning int32_t)
(* ExpirationAge : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rpcns4 (t "RPCNS4.dll"))
(cffi:use-foreign-library rpcns4)

(cffi:defcfun ("RpcNsMgmtSetExpAge" rpc-ns-mgmt-set-exp-age :convention :stdcall) :int32
  (expiration-age :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RpcNsMgmtSetExpAge = Win32::API::More->new('RPCNS4',
    'int RpcNsMgmtSetExpAge(DWORD ExpirationAge)');
# my $ret = $RpcNsMgmtSetExpAge->Call($ExpirationAge);
# ExpirationAge : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型