IFsrmExportImport::ImportFileScreenTemplates method

Imports one or more file screen templates from the specified file.

Syntax


HRESULT ImportFileScreenTemplates(
  [in]   BSTR filePath,
  [in]   VARIANT *templateNamesSafeArray,
  [in]   BSTR remoteHost,
  [out]  IFsrmCommittableCollection **templates
);

Parameters

filePath [in]

The full path to the file from which to import the file screen templates. The string is limited to 260 characters.

templateNamesSafeArray [in]

A variant that contains the names of the file screen templates to import. Set the variant to empty or NULL to import all templates.

Set the variant type to both VT_ARRAY and VT_VARIANT and the parray member to the SAFEARRAY of BSTRs.

remoteHost [in]

The name of the remote server. To specify the local server, set to an empty string.

templates [out]

An IFsrmCommittableCollection interface that contains a collection of IFsrmFileScreenTemplateImported interfaces. To complete the import, you must call the IFsrmFileScreenTemplateImported::Commit method.

Return value

The method returns the following return values.

Return codeDescription
S_OK

Success.

FSRM_E_NOT_FOUND

One of the requested templates was not found in the XML.

FSRM_E_INVALID_IMPORT_VERSION

The version of the XML used is not consistent with the schema defined for FSRM in Windows Server 2008.

E_INVALIDARG

Returned for the following reasons:

  • The filePath or templates parameter is NULL.
  • The variant array does not contain strings.

 

Remarks

You can also use the IFsrmFileScreenTemplateManager::ImportTemplates method to import the templates.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

Fsrm.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, FsrmScreen.h, or FsrmTlb.h)

DLL

SrmSvc.dll

CLSID

CLSID_FsrmExportImport is defined as 1482dc37-fae9-4787-9025-8ce4e024ab56

IID

IID_IFsrmExportImport is defined as efcb0ab1-16c4-4a79-812c-725614c3306b

See also

FsrmExportImport
IFsrmExportImport

 

 

Show:
© 2014 Microsoft. All rights reserved.