IFsrmFileScreen::ApplyTemplate method

[This method is supported for compatibility but it's recommended to use the FSRM WMI Classes to manage FSRM. Please see the MSFT_FSRMFileScreen class.]

Applies the property values of the specified file screen template to this file screen object.

Syntax


HRESULT ApplyTemplate(
  [in]  BSTR fileScreenTemplateName
);

Parameters

fileScreenTemplateName [in]

The name of the file screen template. The string is limited to 4,000 characters.

Return value

The method returns the following return values.

Return codeDescription
S_OK

Success

E_INVALIDARG

The fileScreenTemplateName parameter cannot be NULL.

FSRM_E_INVALID_NAME

The specified name cannot be empty.

FSRM_E_OUT_OF_RANGE

The specified name is too long.

FSRM_E_NOT_FOUND

The specified template was not found.

 

Remarks

To save the changes, call the IFsrmFileScreen::Commit method.

The specified template must be a committed template; you cannot apply a newly created template that has not been committed.

Examples

For an example, see Defining a File Screen.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmScreen.h

IDL

FsrmScreen.idl

DLL

SrmSvc.dll

IID

IID_IFsrmFileScreen is defined as 5f6325d3-ce88-4733-84c1-2d6aefc5ea07

See also

IFsrmFileScreen
MSFT_FSRMFileScreen

 

 

Show:
© 2014 Microsoft