IFsrmExportImport::ExportFileScreenTemplates method

Exports one or more file screen templates to the specified file.

Syntax


HRESULT ExportFileScreenTemplates(
  [in] BSTR    filePath,
  [in] VARIANT *templateNamesSafeArray,
  [in] BSTR    remoteHost
);

Parameters

filePath [in]

The full path to the export file that will contain the file screen templates in XML format. The string is limited to 260 characters.

templateNamesSafeArray [in]

A variant that contains the names of the file screen templates to export. Set the variant to empty or NULL to export 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.

Return value

This method can return the following error codes.

S_OK

Success

S_FALSE

There were no items to export. The export file was not created.

E_INVALIDARG

Returned for the following reasons:

  • The filePath parameter is NULL.
  • The variant array does not contain strings.
HRESULT_FROM_WIN32(ERROR_FILE_EXISTS)

The specified file already exists.

FSRM_E_NOT_FOUND

One of the names in the list was not valid. The XML string is empty.

Remarks

The file screen template name is specified when you call the IFsrmFileScreenTemplateManager::CreateTemplate method. To enumerate the templates, call the IFsrmFileScreenTemplateManager::EnumTemplates method.

You can also use the IFsrmFileScreenTemplateManager::ExportTemplates method to export 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: