RpcNsMgmtInqExpAge

関数

名前サービスの既定のキャッシュ有効期限を取得する。

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

シグネチャ

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

RPC_STATUS RpcNsMgmtInqExpAge(
    DWORD* ExpirationAge
);

パラメーター

名前	型	方向	説明
ExpirationAge	DWORD*	inout	既定の有効期限 (秒単位) へのポインター。この値は、すべてのネームサービスの next 操作で使用されます。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcNsMgmtInqExpAge 関数は、ネームサービスデータのローカルコピーに対するグローバルな有効期限 (expiration age) を返します。

戻り値

値	意味
RPC_S_OK	呼び出しに成功しました。

メモ有効なエラーコードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

RpcNsMgmtInqExpAge 関数は、アプリケーションが使用している有効期限を返します。有効期限とは、ネームサービス属性から取得したデータのローカルコピーが、アプリケーションからのその属性に対する要求によってローカルコピーの更新が必要になるまで存在できる時間 (秒単位) です。アプリケーションの実行が開始されると、RPC ランタイムライブラリは既定の有効期限として 2 時間を設定します。この既定値はアプリケーション全体に対してグローバルです。

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

アプリケーションは通常、既定の有効期限のみを使用するべきです。ただし特殊なケースでは、 RpcNsMgmtSetExpAge を呼び出すことで、既定値の代わりにユーザーが指定したグローバルな有効期限を使用できます。 RpcNsMgmtInqExpAge 関数は、既定値かユーザー指定の値かにかかわらず、現在のグローバルな有効期限を返します。また、 RpcNsMgmtHandleSetExpAge 関数を呼び出すことで、グローバルな有効期限を一時的に上書きすることもできます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RpcNsMgmtInqExpAge(
    DWORD* ExpirationAge
);

[DllImport("RPCNS4.dll", ExactSpelling = true)]
static extern int RpcNsMgmtInqExpAge(
    ref uint ExpirationAge   // DWORD* in/out
);

<DllImport("RPCNS4.dll", ExactSpelling:=True)>
Public Shared Function RpcNsMgmtInqExpAge(
    ByRef ExpirationAge As UInteger   ' DWORD* in/out
) As Integer
End Function

' ExpirationAge : DWORD* in/out
Declare PtrSafe Function RpcNsMgmtInqExpAge Lib "rpcns4" ( _
    ByRef ExpirationAge As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcNsMgmtInqExpAge = ctypes.windll.rpcns4.RpcNsMgmtInqExpAge
RpcNsMgmtInqExpAge.restype = ctypes.c_int
RpcNsMgmtInqExpAge.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # ExpirationAge : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCNS4.dll')
RpcNsMgmtInqExpAge = Fiddle::Function.new(
  lib['RpcNsMgmtInqExpAge'],
  [
    Fiddle::TYPE_VOIDP,  # ExpirationAge : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcns4")]
extern "system" {
    fn RpcNsMgmtInqExpAge(
        ExpirationAge: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCNS4.dll")]
public static extern int RpcNsMgmtInqExpAge(ref uint ExpirationAge);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCNS4_RpcNsMgmtInqExpAge' -Namespace Win32 -PassThru
# $api::RpcNsMgmtInqExpAge(ExpirationAge)

#uselib "RPCNS4.dll"
#func global RpcNsMgmtInqExpAge "RpcNsMgmtInqExpAge" sptr
; RpcNsMgmtInqExpAge varptr(ExpirationAge)   ; 戻り値は stat
; ExpirationAge : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCNS4.dll"
#cfunc global RpcNsMgmtInqExpAge "RpcNsMgmtInqExpAge" var
; res = RpcNsMgmtInqExpAge(ExpirationAge)
; ExpirationAge : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCNS4.dll"
#cfunc global RpcNsMgmtInqExpAge "RpcNsMgmtInqExpAge" sptr
; res = RpcNsMgmtInqExpAge(varptr(ExpirationAge))
; ExpirationAge : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。