CreateFMJAction method of the MSFT_FSRMFMJAction class

  • Artikel

Creates a new MSFT_FSRMFMJAction instance.

Syntax

uint64 CreateFMJAction(
  [in]  uint32             Type,
  [in]  string             ExpirationFolder,
  [in]  boolean            RMSFolderOwner,
  [in]  string             RMSFullControlUser[],
  [in]  string             RMSReadUser[],
  [in]  string             RMSWriteUser[],
  [in]  string             RMSTemplate,
  [in]  string             Command,
  [in]  string             WorkingDirectory,
  [in]  string             CommandParameters,
  [in]  uint32             SecurityLevel = LocalService,
  [out] MSFT_FSRMFMJAction Action
);

Parameters

Type [in]

Specifies the type of the action.

Expiration (1)

The action is an expiration action.

Custom (2)

The action is a custom action.

RMS (3)

The action is a Rights Managed Services (RMS) action.

ExpirationFolder [in]

A string representing a path to a local or remote folder. Optional. Size must not exceed the value of MAX_PATH (260).

This parameter is required when the Type parameter is 1 (Expiration).

RMSFolderOwner [in]

Add the FolderOwner to the full control list if True. Has no effect if no FolderOwner is available for the file.

This parameter is only examined when the Type parameter is 3 (RMS) and the RMSTemplate parameter is empty.

RMSFullControlUser [in]

An array of user email addresses to provide with full control. Each string must be less than 1KB in size.

This parameter is required when the Type parameter is 3 (RMS) and the RMSTemplate parameter is empty.

RMSReadUser [in]

An array of user email addresses to provide with read access. Each string must be less than 1KB in size.

This parameter is only examined when the Type parameter is 3 (RMS) and the RMSTemplate parameter is empty.

RMSWriteUser [in]

An array of user email addresses to provide with write access. Each string must be less than 1KB in size.

This parameter is only examined when the Type parameter is 3 (RMS) and the RMSTemplate parameter is empty.

RMSTemplate [in]

The name of an RMS template. Must be fewer than 1000 characters.

This parameter is required when the Type parameter is 3 (RMS) and the RMSFullControlUser parameter is empty.

Command [in]

A string that refers to a valid executable file. Must not exceed the length of MAX_PATH (260). Required.

This parameter is required when the Type parameter is 2 (Custom).

WorkingDirectory [in]

A string that refers to a valid path to a folder. Must not exceed the length of MAX_PATH (260). Optional. Remote paths are not supported. The default value is an empty string.

This parameter is only examined when the Type parameter is 2 (Custom).

CommandParameters [in]

A string up to 10KB in size.

This parameter is only examined when the Type parameter is 2 (Custom).

SecurityLevel [in]

The default value is 2 (LocalService).

This parameter is only examined when the Type parameter is 2 (Custom).

None (0)

The security level is not specified.

NetworkService (1)

The action is run in the context of the NetworkService Account.

LocalService (2)

The action is run in the context of the LocalService Account.

LocalSystem (3)

The action is run in the context of the LocalSystem Account.

Action [out]

On output contains a new instance of the MSFT_FSRMFMJAction class.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012
Namespace
 Root\Microsoft\Windows\FSRM
MOF
MSFT_FSRM.mof
DLL
SrmSvc.dll

See also

MSFT_FSRMFMJAction