3.2.4.2.25.2 GetFileGroup (Opnum 8)

  • Article

The GetFileGroup method returns a pointer to the file group with the specified Name property from the List of Persisted File Groups (section 3.2.1.3).

 [id(FSRM_DISPID_FILEGROUP_MANAGER | 0x02)] HRESULT GetFileGroup(
   [in] BSTR name,
   [out, retval] IFsrmFileGroup** fileGroup
 );

name: Contains the Name of the file group to return. The maximum length of this string MUST be 4,000 characters.

fileGroup: Pointer to an IFsrmFileGroup interface pointer (section 3.2.4.2.23) that upon completion points to the file group with the specified Name property. The caller MUST release the file group when it is done with it.

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

Return value/code

Description

0x80045301

FSRM_E_NOT_FOUND

The specified file group could not be found.

0x80045308

FSRM_E_INVALID_NAME

The specified name is not valid.

0x8004530D

FSRM_E_OUT_OF_RANGE

The content of the name parameter exceeds the maximum length of 4,000 characters.

0x80070057

E_INVALIDARG

The fileGroup parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that fileGroup is not NULL.

If any validation fails, the server MUST terminate processing and return a nonzero error code.

Upon successful validation of parameters, the server MUST perform the following actions or return a nonzero error code.

If a Persisted File Group with the specified Name property does not exist, the server MUST return FSRM_E_NOT_FOUND.