Skip to content

IGR_Subfiles_Reset

IGR_Subfiles_Reset resets an enumeration to its initial state, positioning it at the beginning. Subsequently, invoke IGR_Subfiles_Next to commence reprocessing the document. Notably, invoking IGR_Subfiles_Reset is unnecessary for the initial iteration.

Prototype

IGR_RETURN_CODE IGR_Subfiles_Reset(
    HSUBFILES enumerator, 
    Error_Control_Block* error);

Parameters

enumerator: HSUBFILES

Handle to an enumerator opened by IGR_Get_Subfiles_Enumerator.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

Return value

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

See Also